For the complete documentation index optimized for AI agents, see llms.txt or llms-full.txt. A markdown version of this page is available by appending.mdto the URL or sendingAccept: text/markdown.
Agent Skills
For AI agents: the documentation index is at llms.txt (full corpus: llms-full.txt). A markdown source for this page is /agent-skills/overview.md.
Arete is designed to be built with AI agents. This page explains the four pieces that make that work: the CLI, the agent skills, agent.md, and the MCP servers.
The CLI
Section titled “The CLI”The Arete CLI (a4) is the primary interface between your agent and Arete. It handles scaffolding, deployment, SDK generation, and — most importantly — live schema discovery.
curl -fsSL https://arete.run/install.sh | sh # macOS / Linuxirm https://arete.run/install.ps1 | iex # Windows PowerShellnpx @usearete/a4 install # if you prefer npmThe installer downloads a prebuilt, signed binary into ~/.local/bin/a4 and prints A4_BIN=<absolute path>. No Rust toolchain is needed. Update later with a4 self update. See CLI Command Reference for flags and environment variables.
Project setup
Section titled “Project setup”a4 init -y # arete.toml, AGENTS.md block, CLAUDE.md import, skills, MCP configa4 doctor --json # exit 0 = ready; each check carries a fixa4 init detects the coding agents present (Claude Code, Cursor, Codex, OpenCode, Gemini CLI, VS Code, and more), installs the skills for each, and writes their MCP config. It is idempotent: re-runs report unchanged. Add --global to install for your user instead of the project.
Discovery
Section titled “Discovery”The key command for agents is a4 explore:
a4 explore --json # installable stacksa4 explore stack <stack-ref> --json # one stack's exact install descriptora4 explore programs --json # installable standalone programsa4 explore program <program-ref> --jsonThis queries the Arete API and returns pinned install descriptors — entities, fields, views, types, and the exact artifact hashes a4 install will consume. Because your agent runs this at setup time, it always works with accurate, up-to-date type information rather than guessing from training data. Every JSON response carries a schemaVersion.
See Schema Discovery for the full output contract.
Install
Section titled “Install”Discovery feeds directly into code generation:
a4 install <stack-ref> --ts # TypeScript clienta4 install <stack-ref> --rust # Rust clienta4 install program <ref> --ts # standalone program SDK (packaged alone: TS today)Generated SDKs are not read-only. Alongside stream subscriptions they expose PDA derivation, account resolution, instruction building, and transaction execution for the programs in scope.
Agent Skills
Section titled “Agent Skills”Agent skills are markdown files that teach your agent how to use Arete correctly. They’re installed into your project so your agent picks them up automatically as context.
Five focused skills are installed together:
| Skill | What it teaches |
|---|---|
arete | Capability discovery, exact descriptors, and project dependency management |
arete-streams | Typed stack views and live subscriptions in TypeScript, React, Rust, and Python |
arete-programs | Account reads, PDAs, instruction building, semantic operations, and transaction safety |
arete-stack-authoring | App-facing read models, join proof, Rust DSL authoring, and portable artifacts |
arete-deploy | Program publication and permission-aware hosted deployment operations |
a4 init installs them for every agent it detects (it runs npx skills add AreteA4/skills under the hood, so Node.js is required for this step). To install them manually, or for one agent only:
npx skills add AreteA4/skillsnpx skills add AreteA4/skills --agent cursorThe skills are one installation bundle but separate activation units, so an agent loads only the workflow relevant to the current task. Generated code, exact descriptors, and the current CLI remain the source of truth for API shapes.
agent.md
Section titled “agent.md”agent.md is a plain text file hosted at https://docs.arete.run/agent.md. It’s the bootstrap instruction set — a single URL your agent can read to set everything up from scratch.
When your agent reads agent.md, it:
- Installs the Arete CLI with the installer (prebuilt binary, no Rust, no account)
- Runs
a4 init -y— writesarete.toml, anAGENTS.mdblock, aCLAUDE.mdimport, the agent skills, and MCP config for both servers - Runs
a4 doctor --jsonto verify the setup - Runs
a4 explore --jsonto load pinned descriptors - Understands it’s ready to build
This is why the one-liner works:
Read https://docs.arete.run/agent.md and follow it to set up Arete in this project, then tell me what live data is available.
MCP Servers
Section titled “MCP Servers”Two MCP servers extend what your agent can do without leaving its loop. Both are optional — the CLI and skills are sufficient on their own.
| Server | Transport | Gives the agent |
|---|---|---|
| Documentation | https://docs.arete.run/mcp (HTTP) | search_docs, fetch_page — read these docs without scraping |
| Stream | a4 mcp (stdio) | connect, subscribe, query_entities, and friends — live entity data in-loop |
a4 init writes both servers (arete and arete-docs) into every detected agent’s MCP config. The stream server is for exploration and debugging, not application code. When you’re writing code that ships, generate an SDK with a4 install.
See MCP Server for setup and the full tool list.
How They Fit Together
Section titled “How They Fit Together”agent.md ──▶ install.sh ──▶ a4 installed a4 init -y ──▶ skills installed ─▶ SDK patterns + DSL syntax MCP configured ─▶ docs search + live entity reads a4 explore ──▶ pinned descriptors
┌────────────────────────────┐ │ AI Agent │ │ (Cursor, Claude Code, etc) │ │ │ │ Skills + Live schemas │ └────────────┬───────────────┘ │ a4 install --ts / --rust │ ▼ typed SDK: streams + transactions │ ▼ Your Arete appThe CLI gives the agent live data and typed clients. The skills give the agent correct patterns. MCP gives it docs and live reads in-loop. Together they remove the two main failure modes: wrong types and wrong API usage.
Prefer to Set Up Manually?
Section titled “Prefer to Set Up Manually?”curl -fsSL https://arete.run/install.sh | sh# Windows: irm https://arete.run/install.ps1 | iex
a4 create my-app --template react-orecd my-app
a4 init -ya4 doctor --jsoncurl -fsSL https://arete.run/install.sh | sh# Windows: irm https://arete.run/install.ps1 | iex
a4 init -ya4 doctor --jsonnpx skills add AreteA4/skillsInstalls the skill files without writing arete.toml, AGENTS.md, or MCP config.
For editor-specific file locations and manual configuration, see Editor Setup.
Next Steps
Section titled “Next Steps”- Prompt Cookbook — Copy-paste prompts for common tasks
- Tutorial: ORE Dashboard — Build a complete app step by step
- Schema Discovery — How
a4 exploreprovides live type information - MCP Server — Documentation and stream MCP setup
- Editor Setup — Manual setup for specific editors