Skip to docs content
Apito CLI sync reference
Fair Source
Updated 2026-10-11

Apito CLI sync reference

The CLI manages accounts and syncs schema, functions, and content. apito sync stages a schema draft. It does not publish. Publish in the console on the destination, including Apito Cloud.

Install

npm install -g @apito/cli
# or follow current install docs for your release
apito --version

Accounts

apito account create
# server URL + cloud sync key / token for that Engine

Point --to at a local engine or at Apito Cloud.

Project to project

apito sync --from local --to production --dry-run
apito sync --from local --to production --yes

Local is http://localhost:5050. Production is https://api.apito.io. Both sides use an apt_ token. The walkthrough is Sync to Cloud.

Filesystem schema (Blueprints)

apito sync --from filesystem --to <account> --type schema --dir blueprints/<slug> --dry-run
apito sync --from filesystem --to <account> --type schema --dir blueprints/<slug> --yes

Then Console → Schema Changes → Publish. Seed with the blueprint’s node scripts/seed.mjs — content is not filesystem-synced.

Export:

apito sync --from <account> --to filesystem --type schema --dir ./export-dir

MCP

apito mcp connect approves a device login in the Console. apito mcp config prints a stdio block that launches apito mcp serve and does not contain a token.

For a remote client, print a URL-only block:

apito mcp config --transport http --account cloud

That block is { "type": "http", "url": "…" }. Cloud is https://api.apito.io/mcp. Local Studio is http://localhost:4055/mcp. A custom account uses that host’s /mcp path. apito mcp serve --transport http speaks stdio to the client and HTTP to that URL. The apito-mcp npm package is deprecated and does not serve tools. APITO_MCP_RUNTIME=node keeps that retired runtime.

What CLI does / does not

Schema Functions Content
Project ↔ project draft stage draft (+ optional deploy) copy rows
Filesystem → project draft stage draft (+ optional deploy) no
Publish schema no deploy ≠ schema publish n/a

Next