Quick Start

Connect your first project to Downcity through one shortest path.

Choose your current system, prepare the CLI and local sandbox, then start from a repository you already run.

Start from one real repository, not a demo project.Close one minimal loop before adding approvals, skills, or extra channels.If multiple people operate the system, define folder boundaries before role split.

01 / Install

Choose your system

The Downcity CLI is consistent across platforms. Each OS provides its own sandbox, so you only install components required by your system.

Requires Node.js 20 or later.

Install Downcity CLI

Recommended

macOS uses the native sandbox-exec boundary for Shell. No Windows sandbox package is installed.

npm install -g downcity
downcity --version

• Sandbox policies confine writes to the active Agent workspace.

Create the agent inside your repo

Initialize inside a real project so rules, permissions, and artifacts stay in the repo instead of a separate platform.

cd /path/to/your-repo
downcity agent create .

Connect City and start runtime

Import the active City session into downcity, then start the runtime. Use foreground mode only when you need live logs in the current shell.

city federation login
city on
# for debugging in the foreground
city on --foreground

Select the Session model

After the Agent starts, select a Federation model for the current Session. The choice is stored with Session runtime data and applies on the next turn without restarting the Agent.

downcity agent model .
# SSH or automation
downcity agent model . --session-id <session-id> --set <model-id>

Run a health check

先确认 City 宿主状态，再接入 Skills、渠道和定时任务。

city status
curl http://localhost:5314/health

Continue in the docs

Once these steps are working, move into the full quick-start guide and connect configuration, skills, and automation.

Read Full Quick Start Back Home