🔍⌘K

Start typing to search docs.

Command Reference

1.0.0

Auto-generated documentation from the Forge CLI command registry.

Deployment

Ship builds, synchronize store assets, and promote releases with confidence.

integrations deployment <appId> <connectionId>

Synchronize deployment provider configuration for an app

Options

--provider <provider>Optional

Deployment provider key (vercel, render, heroku)

--project-id <id>Optional

Deployment project identifier

--branch <branch>Optional

Git branch to sync

--no-sync-environmentOptional

Skip environment variable sync

Default: false

--metadata <json>Optional

Additional metadata payload (JSON)

promote <appId>

Promote app between environments/tracks

Arguments

appIdRequired

App ID to promote

Options

--config <path>Optional

Path to apps.yaml configuration file

--from <track>Optional

Source track/environment

Default: internal

--to <track>Optional

Target track/environment

Default: external

--platform <platform>Optional

Target platform (ios, android, web, all)

Default: all

--dry-runOptional

Show what would be promoted without making changes

Default: false

--forceOptional

Force promotion without confirmation

Default: false

store:sync <appId>

Sync app metadata and assets with app stores

Arguments

appIdRequired

App ID to sync with stores

Options

--config <path>Optional

Path to apps.yaml configuration file

--platform <platform>Optional

Target platform (ios, android, all)

Default: all

--no-metadataOptional

Skip metadata sync

Default: false

--no-screenshotsOptional

Skip screenshot sync

Default: false

--no-iapsOptional

Skip In-App Purchases sync

Default: false

--no-testersOptional

Skip testing groups sync

Default: false

--dry-runOptional

Show what would be synced without making changes

Default: false

--forceOptional

Force overwrite existing store data

Default: false

submit <appId> [platforms...]

Build, run screenshots matrix, upload binaries + metadata, notify with links

Arguments

appIdRequired

App ID to submit

platformsOptional

Platforms to submit to (ios, android, web). Defaults to all configured platforms

Options

--config <path>Optional

Path to apps.yaml configuration file

--skip-screenshotsOptional

Skip screenshot generation and upload

Default: false

--skip-buildOptional

Skip building the app (use existing build)

Default: false

--skip-uploadOptional

Skip uploading to stores (build and screenshot only)

Default: false

--track <track>Optional

Android track to upload to (internal, alpha, beta, production)

--no-externalOptional

iOS: Skip external TestFlight distribution

Default: false

--dry-runOptional

Show what would be submitted without making changes

Default: false

Development

Local development workflows for web, mobile, and backend services.

db draft

Generate a merge plan for SQL drafts against the local migration manifest

Options

--app <slug>Optional

Target app slug whose drafts should be evaluated

--output <path>Optional

Optional file path to write the plan report

--base-dir <path>Optional

Override the migration fixtures directory

dev <appId>

Start local backend and development servers for an app

Arguments

appIdRequired

App ID to start development environment for

Options

--webOptional

Start web development server only

Default: false

--mobileOptional

Start mobile development server only

Default: false

--backendOptional

Start backend services only

Default: false

--skip-backendOptional

Skip starting backend services

Default: false

--skip-port-checkOptional

Skip port availability checks

Default: false

--config <path>Optional

Path to apps.yaml configuration file

integrations repo <appId> <repository>

Link a source control repository to the app workspace

Options

--provider <provider>Optional

Repository provider (default github)

--link-id <id>Optional

Existing link ID to update

--installation-id <id>Optional

GitHub App installation ID

--default-branch <branch>Optional

Default branch name

Default: main

--metadata <json>Optional

Additional metadata payload (JSON)

Generation

Spin up new applications, scaffold code, and configure environments from configuration.

new <appId>

Create a new app from configuration with React web and/or React Native templates

Arguments

appIdRequired

App ID from apps.yaml

Options

--web <target>Optional

Web target: react or nextjs (generates web app)

--mobileOptional

Generate React Native mobile app

Default: false

--flutterOptional

Generate Flutter mobile app (stub implementation)

Default: false

--config <path>Optional

Path to apps.yaml configuration file

--output <path>Optional

Output directory for apps

--overwriteOptional

Overwrite existing app directory

Default: false

Infrastructure

Provision and synchronize infrastructure across Supabase, Pulumi, and cloud providers.

integrations billing <appId> <connectionId>

Trigger billing connector workflow for an integration connection

Options

--provider <provider>Optional

Override provider key (defaults to Stripe)

--account-id <id>Optional

Billing account identifier to associate

--scopes <scopes>Optional

Comma-separated OAuth scopes to request

--metadata <json>Optional

Additional metadata payload (JSON)

provision <appId> <stack>

Provision infrastructure for an app with specified stack (local, staging, prod)

Arguments

appIdRequired

App ID to provision infrastructure for

stackRequired

Target stack (local, staging, prod)

Options

--config <path>Optional

Path to apps.yaml configuration file

--provider <provider>Optional

Infrastructure provider (aws, gcp, auto)

--dry-runOptional

Show what would be provisioned without creating resources

Default: false

--forceOptional

Force refresh of existing resources

Default: false

--update-secretsOptional

Update secret manager with outputs

Default: true

--update-envOptional

Update .env.generated files with outputs

Default: true

--workspace <name>Optional

Override Pulumi workspace name

--project-ref <ref>Optional

Supabase project reference

--metadata <json>Optional

Additional metadata (JSON)

sync-pulumi-secrets

Sync Pulumi stack outputs to Doppler and regenerate environment files

Options

-e, --environment <env>Optional

Target environment

Default: production

-a, --app <app>Optional

Target app name

-d, --dry-runOptional

Show what would be done without making changes

Default: false

-v, --verboseOptional

Enable verbose logging

Default: false

-c, --config <path>Optional

Path to mapping configuration file

--skip-envOptional

Skip environment file regeneration

Default: false

Utilities

Supporting tasks that manage secrets, billing artifacts, and diagnostic tooling.

billing:seed

Create or update Stripe products and prices for billing plans

Options

--env <environment>Optional

Target environment (development, staging, production)

Default: development

--stripe-key <key>Optional

Stripe secret key (or use STRIPE_SECRET_KEY env var)

--output <path>Optional

Output directory for .env.generated files

--dry-runOptional

Show what would be created without making changes

Default: false

--forceOptional

Force update of existing products and prices

Default: false

doctor

Run diagnostics on configuration, assets, and secrets

Options

--config <path>Optional

Path to apps.yaml configuration file

--apps <path>Optional

Path to apps directory

--output <path>Optional

Output path for markdown report (optional)

--no-colorOptional

Disable colored output

Default: false

generate-env

Generate .env.generated files for all apps and platforms

Options

--config <path>Optional

Path to apps.yaml configuration file

--output <path>Optional

Output directory for app folders

--dry-runOptional

Show what would be generated without creating files

Default: false

login

Authenticate with Forge API and store credentials

Options

--api-key <key>Optional

API key for authentication

--base-url <url>Optional

Base URL for Forge API

--organization-id <id>Optional

Organization ID

logout

Clear stored API credentials

whoami

Show current authentication status and configuration