Quick Start
Get up and running with ID Agents in minutes
Quick Start#
Copy the prompt below and paste it into Claude Code, Codex CLI, or Cursor CLI.
Find https://github.com/idchain-world/id-agents.git then read and follow the QUICKSTART.md file in the repo.
Manual install (advanced)#
If you'd rather run each step yourself, follow the path below. This is the fresh-install path written out for humans; the prompt above decides whether to refresh an existing checkout or clone a new one.
Prerequisites#
- Node.js 22 or later
- Claude Code CLI -- install from claude.ai/code and run
claude login, and/or - OpenAI Codex CLI -- install from github.com/openai/codex and run
codex login, and/or - Cursor CLI -- install from cursor.com with
curl https://cursor.com/install -fsS | bashand runcursor-agent login
1. Install#
git clone https://github.com/idchain-world/id-agents.git
cd id-agents
npm install
2. Add the Admin Control Skill#
Copy the admin-control skill to your Claude Code project so you can manage agents programmatically:
cp -r /path/to/id-agents/skills/admin-control /your/project/.claude/skills/
Replace the paths with your actual directories.
3. Start the Manager#
cd /path/to/id-agents
mkdir -p ./workspace/{teams,manager,agents,logs}
export AGENT_MANAGER_WORKDIR="$(pwd)/workspace"
export ID_WORKSPACE_DIR="$(pwd)/workspace"
npm run id-agents
This starts the manager daemon on port 4100 with the interactive CLI attached to the same process. The CLI does not bind its own network port. Wait until you see the prompt before continuing.
4. Deploy a Team#
Deploy a team using the admin-control skill or the /remote endpoint on the manager daemon. Ship configs:
default-- 2-agent Claude starter (coder + researcher). Use this first.idchain-- 13-agent team covering the full ID Chain system.apps-- app team.personal-- personal team.
Deploy default:
curl -s -X POST http://localhost:4100/remote \
-H "Content-Type: application/json" \
-d '{"command":"/deploy default"}'
Mixed Claude + Codex + Cursor runtime is not a separate config -- the detect-runtimes script at setup decides which runtime each agent uses based on what CLIs you have logged in, so default (or any config) can run mixed if the CLIs you need are installed and authenticated.
Dispatch returns immediately with a query ID:
{ "ok": true, "result": { "queryId": "q_1a2b3c" } }
Poll the reply with ?wait=30 to long-poll up to 30 seconds for a result:
curl -s "http://localhost:4100/query/q_1a2b3c?wait=30"
5. Talk to Your Agents#
List agents:
curl -s -X POST http://localhost:4100/remote \
-H "Content-Type: application/json" \
-d '{"command":"/agents"}'
Ask an agent a question:
curl -s -X POST http://localhost:4100/remote \
-H "Content-Type: application/json" \
-d '{"command":"/ask coder Introduce yourself and tell me what you can do."}'
6. Use the CLI Directly#
For a richer experience, launch the interactive CLI in your terminal:
cd /path/to/id-agents
npm run id-agents
Type /help to see all available commands. Some useful ones:
/agents List all agents
/ask coder <message> Talk to an agent
/news coder Check recent messages
/deploy <config> Deploy agents from YAML config
/register <agent> Register agent onchain
7. Create Your Own Team#
Create a YAML config in configs/. The YAML is infrastructure-only -- agent personality and role instructions go in template files (see Configuration):
team: my-team
defaults:
runtime: claude-code-cli
skills: [identity, inter-agent, catalog, task-discipline]
agents:
- name: frontend
workingDirectory: /path/to/frontend-project
heartbeat: 86400
- name: backend
workingDirectory: /path/to/backend-project
heartbeat: 86400
Then deploy with /deploy my-config in the CLI. To update a running team after changing your config, use /sync my-config -- it preserves unchanged agents and only restarts what changed.
Tip: The
task-disciplineskill ensures agents use the/taskslifecycle for all non-trivial work, making team activity auditable.
Next Steps#
- CLI Reference -- Full command list and usage
- Configuration -- All YAML and environment options
- REST-AP Protocol -- How agents discover and communicate
- XMTP Messaging -- Encrypted messaging via ENS names
- Skills -- Extend what agents can do
- Onchain Identity -- Register agents on ID Chain