Introducing Forge CLI
Command line interface for GetForge.com — deploy and manage your Forge sites from the terminal.
Quick Start
npm install -g @beachio/forge-cli
forge login
forge create --name my-site
forge add my-site.getforge.io
forge deploy
Requires Node.js 18 or later.
What You Can Do
Forge CLI gives you full control of your Forge sites without leaving the terminal:
- Deploy sites from the command line or CI/CD pipelines
- Create and manage sites, custom domains, and SSL
- Roll back to previous versions instantly
- Manage environment variables, settings, and build configuration
- Automate workflows with JSON output, scoped tokens, and CI/CD integration
- Monitor bandwidth usage, build minutes, and version history
Global Options
These options apply to all commands:
| Option | Description |
|---|---|
| --json | Output results as JSON |
| --quiet | Suppress all output except errors |
| --token |
Authenticate with a CLI token |
| --site-token |
Authenticate with a site token |
| -v, --version | Show version |
| --help | Show help for any command |
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Authentication failure |
| 3 | Insufficient token scope |
| 4 | Rate limited |
Output Modes
forge sites --json # JSON output for scripting and CI/CD
forge deploy --quiet # Minimal output, exit codes only
All commands support --json and --quiet. JSON mode outputs structured data suitable for piping to jq or consuming from scripts and AI agents.
Join the Discussion
Have questions or want to share your experience? Join our community discussion to connect with other developers and get help from the Forge team.
Visit Forum Discussion