Complete Community Edition under Apache 2.0. No telemetry.See the source

Every top-level command, in one place you can search.

This reference follows main c985198. The npm 0.3.0-beta.22 package has 18 commands; shortcut is already on main and has not been published yet. Search by command, concept, or behaviour.

Global options

--help shows the installed surface and --version prints the exact version. If a later release differs from this page, the CLI wins.

TERMINAL
agents-city --helpagents-city --version
01

Start and configure

Create cities, define agents, mount their work, and select the goal and runtimes.

agents-city [hall]#

Open the local Town Hall for the selected city.

The Hall binds to 127.0.0.1, opens on the map, and shows configuration plus a read-only live view of visible agent and committee activity.

TERMINAL
agents-cityagents-city hall --city productagents-city hall --no-browser
agents-city setup#

Create or select a city and open the Hall.

The default flow uses the browser Hall. --tui hands onboarding to seat; --demo opens the default disposable Aurora Games walkthrough.

TERMINAL
agents-city setupagents-city setup --city productagents-city setup --city product --tuiagents-city setup --demo
agents-city seat#

Configure and open the city chair plus its repository-agent windows.

seat persists domain, chair role, repositories, per-repo roles, goal, and engine choices. --only, --model, --effort, --no-yolo, and --no-sync apply to one launch only.

TERMINAL
agents-city seatagents-city seat --city productagents-city seat --repos --agent-rolesagents-city seat --enginesagents-city seat --only api,webagents-city seat --model sonnet --effort high
agents-city cities#

List, create, or select local cities without starting them.

A user may own several isolated cities. create writes a managed city folder; use only changes the selected city.

TERMINAL
agents-city cities listagents-city cities currentagents-city cities create client-aagents-city cities use product
agents-city agents#

List agents and manage the work mounted into their private workspaces.

The agent is the member unit. Its workspace may mount a repository, worktree, document folder, several sources, or none. Legacy repo-only cards are normalised to the same model.

TERMINAL
agents-city agents list --data ~/.agents-city/alice/product --card ~/.agents-city/alice/product/alice.mdagents-city agents mount --data ~/.agents-city/alice/product --agent writer --src ~/Documents/handbookagents-city agents mounts --data ~/.agents-city/alice/product --agent writeragents-city agents unmount --data ~/.agents-city/alice/product --agent writer --name handbook
02

Coordinate

Open explicit roads, exchange information, and chair bounded decisions.

agents-city road#

Open or close the explicit allowlist between two city seats.

Local connect writes both ends symmetrically. Remote cities exchange public invitation files and each side accepts independently.

TERMINAL
agents-city road list productagents-city road connect product client-aagents-city road invite product > product.invitation.jsonagents-city road connect product research.invitation.jsonagents-city road disconnect product client-a
agents-city bus#

Send information from one seat across a declared road.

roster shows allowed destinations and presence. inbox consumes pending delivery while append-only history remains. Only the seat may send road messages.

TERMINAL
agents-city bus rosteragents-city bus inboxagents-city bus send alice/research "Confirm the event contract"agents-city bus send '*' "Notice for every connected city"
agents-city committee#

Run an authenticated, chair-mediated deliberation inside one city.

The state machine covers open, respond, synthesise, floor requests, one scoped reply, decide, verify, replan, close, and cancel. Mutations accept flags or JSON through --input.

TERMINAL
agents-city committee listagents-city committee historyagents-city committee schema openagents-city committee open --input proposal.jsonagents-city committee show <deliberation-id>
03

Observe and measure

Inspect capabilities, draw the map, run the demo, and read evidence.

agents-city skills#

Recognise skills that already live in each repository.

This command is read-only. It recognises common SKILL.md layouts and reports capabilities; it never installs, copies, enables, or removes a skill.

TERMINAL
agents-city skillsagents-city skills product
agents-city city#

Open one city map without starting an agent session.

The map binds to loopback and reads city units, parcels, owner card, and bus state. Ctrl-c stops the local server.

TERMINAL
agents-city cityagents-city city ~/.agents-city/alice/product
agents-city shortcut#

Put a named city and its own icon on the desktop.

Current main writes a real macOS app, Linux .desktop entry, or Windows .lnk through WSL. Every shortcut runs the same CLI entry point; --hall opens the browser map instead of the tmux seat.

TERMINAL
agents-city shortcutagents-city shortcut productagents-city shortcut product --hallagents-city shortcut --removeagents-city shortcut --to ~/bin
agents-city demo#

Run one of three disposable, human-readable Hall and committee walkthroughs.

Choose Aurora Games, Clínica Alba, or Costa & Ley. The demo starts no models and needs no provider account. Every story crosses the real authenticated bus, committee state machine, durable ledger, spectator feed, verification failure, and replan path.

TERMINAL
agents-city demoagents-city demo --domain medicinaagents-city demo --domain legalagents-city demo --no-browser
agents-city report#

Compute map growth from configured folders and optionally push it.

Without --push it only computes and displays the report. --url and --token may override an optional city service.

TERMINAL
agents-city reportagents-city report --data ~/.agents-city/alice/productagents-city report --push --quiet
agents-city tokens#

Aggregate local Claude transcript usage without sending prompts or paths.

The command reports totals only. It does not automatically estimate Codex, OpenCode, or Kimi usage.

TERMINAL
agents-city tokensagents-city tokens --days 7agents-city tokens --allagents-city tokens --push --quiet
agents-city logs#

Read visible semantic activity or secret-scrubbed diagnostics.

Activity includes visible prompts, answers, work, and committee events. Diagnostics covers hub, socket, gateway, hook, and launcher operations. Provider reasoning is excluded.

TERMINAL
agents-city logsagents-city logs --activity --lines 50agents-city logs --diagnostics --lines 200agents-city logs --json --follow
04

Operate and maintain

Benchmark, reset, close, and validate the installation.

agents-city benchmark#

Measure local stress, real-runtime latency, or committee protocol behaviour.

Stress runs offline without model quota. Live runtime measurement is opt-in and consumes the configured provider quota. Committee benchmarks compare the structured protocol with an unbounded chat.

TERMINAL
agents-city benchmark stressagents-city benchmark live --runtime codexagents-city benchmark committee
agents-city reset#

Return one explicit city to onboarding with a recovery copy.

reset clears that city’s seat/onboarding state and local road endpoints, preserves its stable identity, and never touches referenced repositories.

TERMINAL
agents-city reset product --dry-runagents-city reset product
agents-city exit#

Close one city session or every Agents City session safely.

Use this instead of killing generic processes. Save active work first: closing a city ends each tmux window in that session.

TERMINAL
agents-city exit product --dry-runagents-city exit productagents-city exit --dry-runagents-city exit
agents-city test#

Run every repository check through the installed command surface.

The complete suite covers Python contracts, TypeScript bundles, runtime adapters, security invariants, demo flow, packaging, and benchmarks that do not require live models.

TERMINAL
agents-city test