Copy page

CLI

CLI overview

The apitogo CLI lets you manage developer portals from the terminal. You scaffold and shape local files, preview with apitogo run, and publish to APItoGo hosting with apitogo deploy.

First time? Install and wire credentials → Install the CLI. Then follow Shape and Go live.

What you get

• Scaffold a local portal site (apitogo init)
• Shape backend, OpenAPI, plans, and docs pages via apitogo config and file edits
• Preview locally (apitogo run)
• Publish to APItoGo hosting (apitogo deploy) with platform plans Free, Starter, or Professional
• Check live status (apitogo status) and tear down (apitogo teardown --yes)

Prerequisites

Shell environment (for deploy / status / teardown)

Variable	Required	Purpose
APITOGO_API_KEY_ID	Yes	Platform API auth
APITOGO_API_SECRET	Yes	Platform API auth

Local machine

• Node.js 20+ (scaffold, build, preview)
• Network access to the npm registry during install/build
• OIDC credentials at publish time (site .env only — never in shell history for sharing)
• Stripe secrets at publish only when you have paid project plans

Changing your site

Approach	When it helps
apitogo config	Wire OpenAPI, custom pages, gateway plans, and site title from the terminal. See Make config.
Edit files directly	Full control — apitogo.config.json, pages/**, landing/LandingPage.tsx, etc.

Common CLI shape tasks:

Change	How
Backend runtime	apitogo config (backend)
OpenAPI files (gateway.specs)	apitogo config (openapi)
Custom docs pages	apitogo config (page) or add under apitogo/portal/pages/
Gateway / API plans	apitogo config (plan) or edit apitogo/plans.json
Site title	--title or edit apitogo.config.json
Theme and fonts	Edit apitogo/portal/theme.json

The home page is apitogo/portal/landing/LandingPage.tsx and the footer apitogo/portal/footer/Footer.tsx, named by portal.landing and portal.footer.

Config model (local site)

File	Role
apitogo.config.json	The services: portal, gateway, identity, plans
apitogo/	Pages, plans, theme, OpenAPI files

Secrets are project secrets (apitogo secrets set), never files. Details: Configuration overview.

CLI vs MCP

Each MCP tool runs one CLI command in the project folder, so both give the same result.

Task	CLI	MCP (agent)
Create	apitogo create	apitogo_create
Shape config	apitogo config + file edits	apitogo_config + file edits
Preview	apitogo run	apitogo run (you start it)
Deploy	apitogo plan / apitogo deploy	apitogo_plan / apitogo_deploy
Status / teardown	apitogo status / apitogo teardown	apitogo_status / apitogo_teardown

Prefer MCP when an agent should drive changes. Prefer CLI for CI, scripts, or terminal-only workflows.

Next

• Install the CLI
• Shape · Go live · Commands
• MCP overview — agent-driven workflow
• Manifest