{
  "id": "page:docs-agent-mux-tutorials-getting-started",
  "_kind": "Page",
  "_file": "wiki/docs/agent-mux/tutorials/getting-started.md",
  "_cluster": "wiki",
  "attributes": {
    "nodeKind": "Page",
    "sourcePath": "docs/agent-mux/tutorials/getting-started.md",
    "sourceKind": "repo-docs",
    "title": "Getting Started",
    "displayName": "Getting Started",
    "slug": "docs/agent-mux/tutorials/getting-started",
    "articlePath": "wiki/docs/agent-mux/tutorials/getting-started.md",
    "article": "\n# Getting Started\n\nThis walkthrough installs `@a5c-ai/agent-mux`, verifies your environment, and runs your first agent.\n\n## 1. Install\n\n```bash\nnpm install -g @a5c-ai/agent-mux\n```\n\nVerify:\n\n```bash\namux --help\n```\n\nYou should see the top-level commands: `run`, `detect`, `agent`, `plugin`, `session`, `hooks`, `remote`.\n\n## 2. Detect available agents\n\n```bash\namux detect\n```\n\nThis probes your `PATH` for each supported adapter (`claude`, `codex`, `cursor`, `gemini`, `opencode`, `opencode-http`, `openclaw`, `copilot`, `hermes`, `pi`, `omp`) and prints version, auth status, and install suggestions for any that are missing.\n\nTo install one via the bundled installer:\n\n```bash\namux agent install claude\n```\n\n## 3. Set credentials\n\nSet the env var required by the agent you want to use, for example:\n\n```bash\nexport ANTHROPIC_API_KEY=sk-ant-...\n```\n\nSee the per-agent pages for exact variables.\n\n## 4. First run\n\n```bash\namux run claude --prompt \"Say hello from agent-mux\"\n```\n\nOr programmatically:\n\n```ts\nimport { createClient } from '@a5c-ai/agent-mux';\n\nconst client = createClient();\nconst handle = await client.run({\n  agent: 'claude',\n  prompt: 'Say hello',\n});\n\nfor await (const ev of handle.events()) {\n  if (ev.type === 'text_delta') process.stdout.write(ev.delta);\n}\n\nawait handle.done();\n```\n\n## Next steps\n\n- [Mock harness](./mock-harness.md) — test without real providers.\n- [Hooks](./hooks.md) — inject policy around tool calls.\n- [Plugins](./plugins.md) — install MCP servers.\n- [Multi-agent](./multi-agent.md) — dispatch to several agents at once.\n",
    "documents": []
  },
  "outgoingEdges": [],
  "incomingEdges": [
    {
      "from": "page:docs-agent-mux-tutorials",
      "to": "page:docs-agent-mux-tutorials-getting-started",
      "kind": "contains_page"
    }
  ]
}