FORGE
Documentation
Examples
Status
GitHub
F

Forge API Documentation

Complete reference for the Forge deployment platform API. Build powerful deployment automation and integrate with your existing workflows.

Getting Started with Forge CLI

Quick Start

Deploy any application in under 60 seconds:

npm install -g forge-deploy-cli && sudo forge infra --all && forge login && forge deploy

Installation

Install Forge CLI globally using npm:

terminal
$ npm install -g forge-deploy-cli

Infrastructure Setup

Setup all required infrastructure components (requires sudo/admin privileges):

terminal
$ sudo forge infra --all

This command automatically installs and configures:

  • Nginx: Reverse proxy with automatic configuration
  • PM2: Process manager with auto-restart
  • SSL Certificates: Automatic Let's Encrypt/Certbot setup
  • Python & Node.js: Runtime dependencies for various frameworks
  • Auto-restart service: Ensures deployments survive reboots

Authentication

Login to your Forge account to enable deployments:

terminal
$ forge login

You'll be prompted to enter your email and password. The CLI will automatically store your API key.

Deploy Your First App

Deploy any Git repository with automatic framework detection:

terminal
$ forge deploy https://github.com/username/my-app.git

Or deploy from the current directory:

terminal
$ forge deploy

Management Commands

Manage your deployments with these commands:

forge status

Check all deployment status

forge logs [id]

View deployment logs

forge pause [id]

Pause a deployment

forge resume [id]

Resume a deployment

forge stop [id]

Stop a deployment

forge infra --ssl

Setup SSL certificates only

Base URL

All API requests should be made to:

https://api.forgecli.tech

Supported Frameworks

Forge automatically detects and deploys these frameworks:

Next.js
React
Vue
Angular
ViteNEW
Node.js
Express
Python/Django
Python/Flask
Python/FastAPI
Static Sites