Copy page

CLI

Install the CLI

Use the apitogo CLI (@lukoweb/apitogo) to scaffold a local portal, shape apitogo.config.json, preview with apitogo run, and publish with apitogo deploy. The MCP tools run these same commands for an agent.

Examples in these docs run apitogo directly, so they assume you have installed the CLI globally (see Install).

Prerequisites

• Node.js 20+
• Platform API credentials from apitogo.com when you run apitogo deploy (API key id + secret)

Install

The CLI is the npm package @lukoweb/apitogo. It exposes the apitogo binary. Install it globally once:

Code
npm install -g @lukoweb/apitogo

Then check that it works from any folder:

Code
apitogo --help

Upgrade later with npm install -g @lukoweb/apitogo@latest. Uninstall with npm uninstall -g @lukoweb/apitogo.

New project (recommended)

apitogo init creates a config version 2 project in the current folder. It shows what it will create and asks first (pass --yes to skip the question), writes apitogo.config.json, uses an existing docs/ folder in place, and, in a new folder, creates package.json and installs @lukoweb/apitogo, react and react-dom:

Code
mkdir my-portal && cd my-portal
apitogo init --name "Books API"
apitogo run

In an existing project the tool never edits your package.json. It prints the install command to run instead.

Named folder or site name:

Code
apitogo init ./my-portal --name "Books API"
cd ./my-portal
apitogo run

Scaffold options

Flag	Effect
[dir]	Target folder (default: the current folder)
--name <string>	Project name (default: the folder's name)
--yes	Do not ask for confirmation
--dry-run	Show what would be created, and write nothing
--force	Replace an existing apitogo.config.json
--json	Print a JSON result payload on stdout

apitogo init is local only — it does not call the platform. After config, run apitogo run to preview, then apitogo deploy when ready to go live.

Global CLI and project scripts

With the global install, run apitogo <command> from any folder (for example apitogo config).

Projects made by init or create also list @lukoweb/apitogo in their package.json, so npm run dev and npm run build use the version pinned in that project.

Platform credentials

Export these before apitogo deploy, apitogo status, or apitogo teardown:

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

Optional:

Variable	Purpose
APITOGO_API_URL	Override platform API base URL
APITOGO_CLI_PATH	Local @lukoweb/apitogo / doc-tool checkout for MCP spawn

Never commit secrets. Secrets such as the Stripe key are project secrets: deploy asks for them, and apitogo secrets set <NAME> changes them. See Go live.

Verify

Code
apitogo --help

You should see init, config, run, build, deploy, status, and teardown.

With credentials set:

Code
apitogo status

Next

• CLI overview
• Shape — scaffold and local preview
• Go live — apitogo deploy
• Commands — full catalog