Forge CLI

Command line interface for GetForge.com — deploy and manage your Forge sites from the terminal.

Install

npm install -g @beachio/forge-cli

Requires Node.js 18 or later.

Quick Start

# Log in with your Forge credentials
forge login

# Create a new site
forge create --name my-site

# Link your project directory to a site
forge add my-site.getforge.io

# Deploy
forge deploy

Global Options

These options apply to all commands:

Option	Description
`--json`	Output results as JSON
`--quiet`	Suppress all output except errors
`--debug-http`	Print full HTTP request/response debug logs
`--token <token>`	Authenticate with a CLI token
`--site-token <token>`	Authenticate with a site token
`-v, --version`	Show version
`--help`	Show help for any command

Authentication

The CLI uses two credential types. They serve different purposes and are stored in different places.

Credential	Scope	Used for
CLI token	Your Forge account	`forge sites`, `forge create`, org/project management, and resolving site tokens via the API
Site token	A single site	`forge deploy`, `forge env`, `forge settings`, `forge versions`, and other site operations

Storage:

~/.forge/credentials.json — CLI token, cached site tokens, org context, deploy watch credentials (email login)
forge.json — linked site URL (site) and optional inline site token (site_token)
Environment — FORGE_TOKEN (CLI), FORGE_SITE_TOKEN (site)
Flags — --token (CLI), --site-token (site)

Which credential does each command need?

Commands	CLI token	Site token
`forge sites`, `forge create`, `forge org `, `forge token `, `forge projects *`	Required	—
`forge deploy`, `forge env`, `forge settings`, `forge versions`, `forge rollback`, `forge usage`	For API lookup	Required (resolved automatically when possible)
`forge destroy`, `forge info`, `forge redeploy`, `forge feedback *`	Required	Required (resolved automatically when possible)

Site tokens are resolved automatically when you have a CLI token and a linked site. You should not need to copy site tokens from the Forge dashboard for normal workflows.

Interactive Login

forge login                              # Prompts for email and password (recommended)
forge login --email me@example.com       # Prompts for password only

Email/password login caches site tokens and enables real-time deploy log streaming.

Direct Token

forge login --with-token <cli-token>     # Store a pre-existing CLI token

Browser Login (OAuth2)

forge login --browser                    # Opens browser for authentication

OAuth login stores a CLI token only. Run forge add <site> to cache site tokens, or use scoped CLI tokens for agents.

Environment Variables

For CI/CD pipelines and automation:

export FORGE_TOKEN=<cli-token>           # CLI token — recommended for agents managing many sites
export FORGE_SITE_TOKEN=<site-token>     # Site token — per-site deploy access

Check Auth Status

forge whoami                             # Show CLI auth, org context, linked site, token sources
forge auth doctor                        # Diagnose token resolution and deploy readiness

Logout

forge logout                             # Clear stored credentials

Token Management

Create scoped tokens for CI/CD and AI agents:

# Full-access token
forge token create

# Scoped deploy token for specific sites
forge token create --name "CI Deploy" --scopes sites:deploy --site-ids 101,102

# Short-lived token for AI agents
forge token create --name "AI Agent" --scopes sites:deploy --site-ids 101 --expires-in-days 7

# List active tokens
forge token list

# Revoke a token
forge token revoke <id>

`forge token create` Options

Option	Description	Default
`--name <name>`	Human-readable label	—
`--scopes <scopes>`	Comma-separated scopes	unrestricted
`--site-ids <ids>`	Comma-separated site IDs to restrict access	all sites
`--expires-in-days <n>`	Days until token expires	90

Available Scopes

Scope	Grants
`sites:read`	List sites, view version info
`sites:write`	Create new sites
`sites:deploy`	Deploy to sites
`forms:read`	Read form submissions
`feedbacks:read`	List and view site feedback
`feedbacks:write`	Resolve, dismiss, or delete feedback
`analytics:read`	Read site analytics
`bandwidth:read`	Read bandwidth usage
`organisations:read`	Read organisations
`organisations:write`	Manage organisations

Tokens created with no scopes have unrestricted access.

Site Management

List Sites

forge sites                              # List all your sites
forge sites --org personal               # Personal sites only
forge sites --org 123                    # Sites under an organisation
forge sites --environment production     # Filter by environment
forge sites --page 1 --limit 20         # Paginate results

Option	Description
`--environment <env>`	Filter by environment (`production`, `staging`, `development`)
`--org <id>`	Filter by organisation ID (`personal` or `0` for personal sites). Defaults to active org from `forge org switch`.
`--page <n>`	Page number (shows single page instead of all results)
`--limit <n>`	Results per page (default: 100, max: 500)

Create a Site

forge create --name my-site              # Create a site at my-site.getforge.io
forge create --name my-app --custom mysite.com   # With a custom domain
forge create --name my-site --org 123    # Under an organisation
forge create --name my-site --project 5  # Create and place in project id 5
forge create --name my-site --project "Marketing Sites"  # Create and place by project name

Option	Description
`--name <name>`	Site name, 3–63 chars, alphanumeric and hyphens (required)
`--custom <domain>`	Custom domain to assign
`--org <id>`	Create under an organisation
`--project <id\|name>`	Add site to a project (folder) by numeric ID or name

When --project is a name rather than a numeric ID, the CLI resolves it automatically.

Link a Directory

forge add my-site.getforge.io            # Validate site, link directory, cache site token
forge add my-site.getforge.io --save-token   # Also write site token to forge.json (CI/agents)
forge add my-site.getforge.io --org 123  # Look up site under a specific organisation

forge add writes the site URL to forge.json, validates the site exists via your CLI token, and caches the site token in credentials. Use --save-token when you want the site token committed to forge.json for CI pipelines.

Site Info

forge info                               # Show info for linked site
forge info --site my-site.getforge.io    # Show info for a specific site

Displays site configuration including SSL, compiler, build settings, environment variables, current version, and deploy status.

Site Feedback

Review and triage tester feedback from staging and development preview sites (User Feedback mode). Feedback is scoped to environment sites, not production.

# List open feedback on a staging/dev site
forge feedback list --site 57972 --status open

# Show full detail (selector, screenshot, client metadata)
forge feedback show 42 --site 57972

# Mark resolved after shipping a fix
forge feedback resolve 42 --site 57972

# Dismiss or delete items
forge feedback dismiss 42 --site 57972
forge feedback delete 42 --site 57972

# JSON output for agents and CI
forge feedback list --site my-site-forge-development.getforge.io --json

Command	Description
`feedback list`	List feedback with optional `--status` and `--type` filters
`feedback show <id>`	Show full feedback detail
`feedback resolve <id>`	Mark feedback as resolved
`feedback dismiss <id>`	Mark feedback as dismissed
`feedback delete <id>`	Permanently delete feedback

Use --site with a numeric site ID, site name/URL, or site token. The sites:read and sites:write scopes also satisfy feedback read/write requirements.

Recommended agent token:

forge token create --name "Feedback review agent" \
  --scopes feedbacks:read,feedbacks:write --site-ids 57972

Delete a Site

forge destroy                            # Delete the linked site (with confirmation)
forge destroy --site my-site.getforge.io # Delete a specific site
forge destroy --force                    # Skip confirmation prompt

Deployment

forge deploy                             # Deploy the linked site
forge deploy -m "added new page"         # Deploy with a version message
forge deploy -d ./build                  # Deploy a specific directory
forge deploy --site my-site.getforge.io  # Deploy to a specific site
forge deploy --no-watch                  # Skip real-time deploy tracking

Option	Description
`-s, --site <site>`	Site name to deploy to
`-m, --message <msg>`	Version description
`-d, --directory <dir>`	Directory to deploy (overrides `forge.json`)
`--no-watch`	Skip real-time deploy log streaming
`--legacy-upload`	Force legacy multipart upload via `api.getforge.com` (slower; fallback if direct upload unavailable)
`--org <id>`	Organisation for site token lookup (defaults to active org from `forge org switch`)

Deploys create a zip archive, upload it directly to storage (same path as gleo.dev), then trigger processing on Forge. Real-time build logs stream back via Pusher. Use --no-watch to return after deploy is queued.

Redeploy (from source)

forge redeploy                           # Redeploy linked site from connected source
forge redeploy --site my-site            # Redeploy a specific site
forge redeploy --site my-site --org 7    # Resolve site under org context
forge redeploy --cache                   # Reprocess current version (no source pull)
forge redeploy --delay 30                # Queue deploy with a 30 second delay

Option	Description
`-s, --site <site>`	Site name
`--org <id>`	Organisation for site token lookup (defaults to active org from `forge org switch`)
`--cache`	Redeploy current version without pulling from source
`--delay <seconds>`	Delay deploy start by N seconds

Redeploy triggers POST /api/v2/cli/redeploy and is useful for CI/CD workflows where Forge pulls from GitHub, Bitbucket, or Dropbox directly.

Versions & Rollback

List Versions

forge versions                           # List version history for linked site
forge versions --site my-site            # For a specific site
forge versions --limit 50 --page 2       # Paginate results

Option	Description
`-s, --site <site>`	Site name
`--limit <n>`	Versions per page (default: 20, max: 100)
`--page <n>`	Page number

Rollback

forge rollback --version-id 789          # Rollback to a specific version
forge rollback -s my-site --version-id 789

Option	Description
`-s, --site <site>`	Site name
`--version-id <id>`	Version ID to rollback to (required, from `forge versions` output)

Site Settings

forge settings --ssl on                  # Enable SSL
forge settings --ssl off                 # Disable SSL
forge settings --force-ssl on            # Force HTTPS redirects
forge settings --compiler jekyll         # Set compiler mode
forge settings --build-command "npm run build"   # Set custom build command
forge settings --build-folder dist       # Set build output folder
forge settings --squish on               # Enable TurboJS minification

Multiple settings can be updated in one call:

forge settings --ssl on --force-ssl on --compiler webpack --build-folder dist

Option	Description
`-s, --site <site>`	Site name
`--ssl <on\|off>`	Enable or disable SSL
`--force-ssl <on\|off>`	Enable or disable forced HTTPS redirects
`--compiler <compiler>`	Compiler (`nothing`, `hammer`, `jekyll`, `middleman`, `webpack`)
`--build-command <cmd>`	Custom build command
`--build-folder <folder>`	Build output folder
`--squish <on\|off>`	Enable or disable TurboJS minification

Environment Variables

forge env                                # List environment variables
forge env set NODE_ENV=production        # Set a variable
forge env set KEY1=val1 KEY2=val2        # Set multiple at once
forge env unset API_KEY                  # Remove a variable
forge env unset KEY1 KEY2               # Remove multiple

Command	Description
`forge env`	List all environment variables for the site
`forge env set <pairs...>`	Set one or more `KEY=VALUE` pairs
`forge env unset <keys...>`	Remove one or more variables by key

All env commands accept -s, --site <site> to target a specific site.

Domain Management

Check DNS

forge domain check --domain mysite.com   # Verify DNS is configured correctly

Returns the current DNS records and instructions for configuring your domain if they don't match.

Set Custom Domain

forge domain set --site-token abc123 --domain mysite.com

Option	Description
`--site-token <token>`	Site token for the target site (required)
`--domain <domain>`	Custom domain to assign (required)

Usage & Bandwidth

forge usage                              # Show bandwidth and build usage
forge usage --days 7                     # Include daily breakdown for last 7 days

Option	Description
`-s, --site <site>`	Site name
`--days <n>`	Days of daily breakdown (default: 30, max: 365)

Displays bandwidth (today, this week, this month, last 30 days), build minutes, and monthly history.

Organisations

List Organisations

forge orgs                               # List your organisations

Switch Context

forge org switch --id 123                # Switch to an organisation
forge org switch --id personal           # Switch back to personal context

When you switch context, subsequent commands like forge sites, forge create, forge projects, and site token lookup default to that organisation. Override with --org on any command.

Projects (Folders)

Projects group related sites together. A project belongs to either a user (personal) or an organisation.

List Projects

forge projects                           # List all your projects
forge projects --org 123                 # Projects under a specific organisation

Create a Project

forge project create "Marketing Sites"          # Personal project
forge project create "Marketing Sites" --org 5  # Under an organisation

Delete a Project

forge project delete 5                   # Delete project (prompts for confirmation)
forge project delete 5 --force           # Skip confirmation (also deletes all sites in the project)

Add a Site to a Project

forge project add-site 5                          # Add linked site (from forge.json)
forge project add-site 5 --site my-site.getforge.io  # Add by URL
forge project add-site 5 --site-id 42            # Add by site ID
forge project add-site 5 --site-token abc123     # Add by site token

Remove a Site from a Project

forge project remove-site 5 --site-id 42         # Remove site from project (site is not deleted)

Create a Site Directly in a Project

forge create --name my-site --project 5
forge create --name my-site --project "Marketing Sites"

The create-then-assign flow is handled automatically — it appears as a single operation.

Project Configuration

Initialize

forge init                               # Create forge.json interactively
forge init --force                       # Overwrite existing forge.json

Creates a forge.json in your project root:

{
  "site": "my-site.getforge.io",
  "deploy_directory": ".",
  "compiler": "none",
  "ignore": ["node_modules", ".git", ".env"]
}

Property	Description
`site`	Site URL to deploy to
`site_token`	Site token (optional, alternative to CLI token)
`deploy_directory`	Directory to deploy (default: `.`)
`compiler`	Compiler mode (`none`, `jekyll`, `middleman`, etc.)
`ignore`	Patterns to exclude from deployment

`.forgeignore`

You can create a .forgeignore file with gitignore-style patterns to exclude files from deployment. This works alongside the ignore array in forge.json.

Site and Token Resolution

Two separate concepts apply to site-scoped commands:

1. Which site? (identity)

--site flag on the command
site in forge.json

2. Which site token? (credential)

--site-token flag or FORGE_SITE_TOKEN env
site_token in forge.json
Cached site tokens in credentials (from login or forge add)
API lookup using your CLI token (respects org context from forge org switch)

If token resolution fails, run forge auth doctor for actionable guidance.

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.

CI/CD and Agent Usage

Recommended: one scoped CLI token for many sites

forge token create --name "Deploy Agent" --scopes sites:deploy --site-ids 101,102,103
export FORGE_TOKEN=<token>
forge deploy --site my-site.getforge.io --json

After forge org switch --id 123, deploy and site commands automatically use that org for token lookup.

Alternative: per-site token in CI

# GitHub Actions — one CLI token, linked project
- name: Deploy to Forge
  env:
    FORGE_TOKEN: ${{ secrets.FORGE_TOKEN }}
  run: |
    npm install -g @beachio/forge-cli
    forge deploy --json

# GitHub Actions — site token only (no account access)
- name: Deploy to Forge
  env:
    FORGE_SITE_TOKEN: ${{ secrets.FORGE_SITE_TOKEN }}
  run: |
    npm install -g @beachio/forge-cli
    forge deploy --json

Use forge auth doctor --json in CI to verify token resolution before deploying.

Exit Codes

Code	Meaning
0	Success
1	General error
2	Authentication failure
3	Insufficient token scope
4	Rate limited

Command Reference

Command	Description
`forge login`	Authenticate with Forge
`forge logout`	Clear stored credentials
`forge whoami`	Show current auth status
`forge auth doctor`	Diagnose auth and site token resolution
`forge token create`	Create a scoped CLI token
`forge token list`	List active CLI tokens
`forge token revoke <id>`	Revoke a CLI token
`forge sites`	List your sites
`forge create`	Create a new site
`forge add <site>`	Link directory to a site
`forge info`	Show site details
`forge destroy`	Delete a site
`forge deploy`	Deploy to Forge
`forge versions`	List version history
`forge rollback`	Rollback to a previous version
`forge settings`	Update site settings
`forge env`	List environment variables
`forge env set`	Set environment variables
`forge env unset`	Remove environment variables
`forge domain check`	Check DNS configuration
`forge domain set`	Assign a custom domain
`forge usage`	Show bandwidth and build usage
`forge orgs`	List organisations
`forge org switch`	Switch organisation context
`forge projects`	List projects (folders)
`forge project create <name>`	Create a new project
`forge project delete <id>`	Delete a project
`forge project add-site <id>`	Add a site to a project
`forge project remove-site <id>`	Remove a site from a project
`forge init`	Create forge.json

Development

git clone https://github.com/beachio/forge-cli.git
cd forge-cli
npm install
npm run build
npm run dev           # Watch mode

License

MIT — Beach.io

Name		Name	Last commit message	Last commit date
.github		.github
bin		bin
src		src
test-site		test-site
.gitignore		.gitignore
.npmignore		.npmignore
.prettierrc		.prettierrc
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
tsup.config.ts		tsup.config.ts

Uh oh!

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Forge CLI

Install

Quick Start

Global Options

Authentication

Which credential does each command need?

Interactive Login

Direct Token

Browser Login (OAuth2)

Environment Variables

Check Auth Status

Logout

Token Management

forge token create Options

Available Scopes

Site Management

List Sites

Create a Site

Link a Directory

Site Info

Site Feedback

Delete a Site

Deployment

Redeploy (from source)

Versions & Rollback

List Versions

Rollback

Site Settings

Environment Variables

Domain Management

Check DNS

Set Custom Domain

Usage & Bandwidth

Organisations

List Organisations

Switch Context

Projects (Folders)

List Projects

Create a Project

Delete a Project

Add a Site to a Project

Remove a Site from a Project

Create a Site Directly in a Project

Project Configuration

Initialize

.forgeignore

Site and Token Resolution

Output Modes

CI/CD and Agent Usage

Exit Codes

Command Reference

Development

License

About

Resources

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Contributors

Languages

`forge token create` Options

`.forgeignore`