Skip to main content

Quick Start

Get AgentVault running in 5 minutes.

Prerequisites​

  • Node.js 18+
  • dfx installed
  • AgentVault CLI (npm install -g agentvault)

1. Initialize Project​

agentvault init my-first-agent
cd my-first-agent

This creates:

my-first-agent/
├── .agentvault/
│   └── config.yaml    # Agent configuration
├── src/
│   └── index.ts       # Agent entry point
└── package.json

2. Start Local ICP​

dfx start --background

Verify:

dfx ping

3. Package Agent​

agentvault package ./

This compiles your agent and prepares deployment artifacts.

4. Deploy​

agentvault deploy --network local

Note the canister ID from the output.

5. Verify​

# Check status
agentvault status

# View details
agentvault info

# Run health check
agentvault health

6. Execute Task​

agentvault exec --canister-id <YOUR_CANISTER_ID> "hello world"

7. View State​

agentvault show --canister-id <YOUR_CANISTER_ID>

8. Create Backup​

agentvault backup --canister-id <YOUR_CANISTER_ID>

What's Next?​

GoalGuide
Learn all featuresTutorial
Deploy to mainnetDeployment Guide
Manage walletsWallet Guide
All CLI commandsCLI Reference

Common Commands​

# List all agents
agentvault list

# View logs
agentvault logs <canister-id>

# Fetch state for local rebuild
agentvault fetch --canister-id <canister-id>

# View canister cycles
agentvault cycles balance <canister-id>

Need Help?​

agentvault --help
agentvault <command> --help

See Troubleshooting for common issues.