Skip to main content

Documentation Index

Fetch the complete documentation index at: https://aixyz.sh/llms.txt

Use this file to discover all available pages before exploring further.

The aixyz package includes the CLI for developing and building agents. Install it to get the aixyz command.
bun add aixyz

Commands

aixyz dev

Starts a local development server with hot reload. Watches app/ and aixyz.config.ts for changes and restarts automatically (100ms debounce).
aixyz dev
aixyz dev --port 4000
FlagDefaultDescription
-p, --port3000Port to listen on
On startup, the dev server prints the A2A and MCP endpoints:
⟡ aixyz.sh v0.0.0

- A2A:          http://localhost:3000/.well-known/agent-card.json
- MCP:          http://localhost:3000/mcp
- Environments: .env, .env.local
If no app/server.ts exists, one is auto-generated from app/agent.ts and app/tools/*.ts.

aixyz build

Bundles your agent for deployment.
aixyz build                       # Standalone (default)
aixyz build --output standalone   # Explicit standalone
aixyz build --output vercel       # Vercel Build Output API v3
aixyz build --output executable   # Self-contained binary
FlagDefaultDescription
--outputstandaloneOutput format: standalone, vercel, or executable
Standalone output goes to .aixyz/output/server.js — run it with bun .aixyz/output/server.js. Vercel output goes to .vercel/output/ using Build Output API v3. Automatically detected when VERCEL=1 is set or configured in aixyz.config.ts. The build process:
  1. Loads environment variables from .env files
  2. Reads and validates aixyz.config.ts
  3. Detects or auto-generates the server entrypoint
  4. Bundles with Bun.build(), materializing the config into the bundle
  5. Copies static assets from public/ and app/icon.png

aixyz erc-8004 register

Registers a new agent on the ERC-8004 IdentityRegistry. Creates app/erc-8004.ts if it doesn’t exist (prompting for supported trust mechanisms), asks for your agent’s deployment URL, and derives the on-chain URI as <url>/_aixyz/erc-8004.json. After a successful registration, the entry is written back to app/erc-8004.ts.
aixyz erc-8004 register --url "https://my-agent.example.com" --chain sepolia --broadcast
FlagDescription
--urlAgent deployment URL (prompted if omitted)
--chainmainnet, sepolia, base-sepolia, localhost
--rpc-urlCustom RPC endpoint
--keystoreEncrypted keystore file
--browserUse browser wallet (EIP-6963)
--broadcastSend transaction (default is dry-run)
--out-dirWrite result JSON to directory

aixyz erc-8004 update

Updates the metadata URI of a registered agent. Reads existing registrations from app/erc-8004.ts, lets you select which one to update (if multiple), and derives the new URI from the provided URL.
aixyz erc-8004 update --url "https://new-domain.example.com" --broadcast
FlagDescription
--urlNew agent deployment URL (prompted if omitted)
--rpc-urlCustom RPC endpoint
--keystoreEncrypted keystore file
--browserUse browser wallet (EIP-6963)
--broadcastSend transaction (default is dry-run)
--out-dirWrite result JSON to directory
See ERC-8004 Identity for the full protocol documentation.