Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.compasslabs.ai/llms.txt

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

​
What is the Compass agent skill?

The Compass agent skill is a packaged, versioned plugin that teaches your AI coding agent to operate Compass through the compass CLI. Instead of wiring up tool definitions yourself, you describe a DeFi action in plain English and the agent does the rest. Tell your agent “find the best USDC vault on Base and deposit 100” or “open a 2x long on ETH”, and it will:
1

Install the CLI if needed

The skill checks for the compass CLI and installs it on first use.
2

Map intent to a command

It translates your request into the right compass subcommand and flags, reading the live command surface with compass --usage and --help.
3

Preview, then run

It previews the call with --dry-run, then executes it.
4

Hand off for signing

Any resulting transaction — an unsigned tx or EIP-712 typed data — is handed back to your wallet to sign.
Non-custodial by design. The CLI returns unsigned transactions / EIP-712 typed data. The skill never holds your keys, signs, or broadcasts — signing is always done with your own wallet.

​
How it compares

The skill is one of three agent surfaces. It sits on top of the CLI — the fastest way to get an autonomous agent transacting on Compass.
Coding AssistantCLIAgent Skill
What it isReference docs for AI assistantsA CLI that calls the APIA plugin that drives the CLI
You doPaste a docs URLRun commands yourselfDescribe the action in chat
Best forGenerating integration codeScripting + manual queriesHands-off agent execution

​
Prerequisites

  • A Compass API key — get one at compasslabs.ai/login, then export COMPASS_API_KEY_AUTH="your_api_key_here".
  • An agent that supports skills/plugins — Claude Code, Cursor, or Codex — or any agent that can read an AGENTS.md file.
The skill installs and configures the compass CLI for you, so you don’t have to set it up first.

​
Install

Add the marketplace, then install the plugin:
/plugin marketplace add CompassLabs/compass-agent-skill
/plugin install compass@compass-labs
Update later with /plugin update compass@compass-labs.

​
Use

In Claude Code, invoke it explicitly: 
/compass find the highest-yield USDC vault on Base and deposit 100
Or just describe a DeFi action in chat — the skill activates on DeFi intents like supplying to Aave, opening a perp, or buying a tokenized equity.

​
What it does not do

  • Sign or broadcast transactions — that’s your wallet, or the gas-sponsorship flow.
  • Track positions over time — it’s a stateless API client; it queries fresh each time.
  • Manage on-chain approvals — your wallet’s responsibility, or Permit2 via gas sponsorship.

CLI

The CLI the skill drives. Every Compass endpoint as a subcommand.

Browse the skill on GitHub

Source, per-agent manifests, and the universal AGENTS.md. MIT-licensed.