> ## 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.

# Agent Skill

> Install the Compass agent skill so Claude Code, Cursor, Codex, or any AI agent can drive Compass on-chain through the CLI — describe a DeFi action in plain English and the agent runs it. Non-custodial.

## 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](/v2/Agents/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:

<Steps>
  <Step title="Install the CLI if needed">
    The skill checks for the `compass` CLI and installs it on first use.
  </Step>

  <Step title="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`.
  </Step>

  <Step title="Preview, then run">
    It previews the call with `--dry-run`, then executes it.
  </Step>

  <Step title="Hand off for signing">
    Any resulting transaction — an unsigned tx or EIP-712 typed data — is handed back to **your** wallet to sign.
  </Step>
</Steps>

<Warning>
  **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.
</Warning>

***

## 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 Assistant                 | CLI                        | Agent Skill                  |
| -------------- | -------------------------------- | -------------------------- | ---------------------------- |
| **What it is** | Reference docs for AI assistants | A CLI that calls the API   | A plugin that drives the CLI |
| **You do**     | Paste a docs URL                 | Run commands yourself      | Describe the action in chat  |
| **Best for**   | Generating integration code      | Scripting + manual queries | Hands-off agent execution    |

***

## Prerequisites

* A **Compass API key** — get one at [compasslabs.ai/login](https://www.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

<Tabs>
  <Tab title="Claude Code">
    Add the marketplace, then install the plugin:

    ```text theme={"system"}
    /plugin marketplace add CompassLabs/compass-agent-skill
    /plugin install compass@compass-labs
    ```

    Update later with `/plugin update compass@compass-labs`.
  </Tab>

  <Tab title="Cursor / Codex">
    The repo ships `.cursor-plugin/` and `.codex-plugin/` manifests that point at the shared skill content. Install it through your agent's plugin mechanism (point it at the [git repo](https://github.com/CompassLabs/compass-agent-skill)), or copy `skills/compass/` into your agent's skills directory.
  </Tab>

  <Tab title="Any other agent">
    Point your agent at the **`AGENTS.md`** (or `GEMINI.md`) file in the [repo](https://github.com/CompassLabs/compass-agent-skill) — it's the same guidance in the widely-read AGENTS.md format. Many agents (Codex, Aider, Cline, Gemini CLI, …) pick it up automatically when it's in the working directory.
  </Tab>
</Tabs>

***

## Use

In Claude Code, invoke it explicitly:

```text theme={"system"}
/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](/v2/Products/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.

***

<CardGroup cols={2}>
  <Card title="CLI" icon="terminal" href="/v2/Agents/CLI">
    The CLI the skill drives. Every Compass endpoint as a subcommand.
  </Card>

  <Card title="Browse the skill on GitHub" icon="github" href="https://github.com/CompassLabs/compass-agent-skill">
    Source, per-agent manifests, and the universal `AGENTS.md`. MIT-licensed.
  </Card>
</CardGroup>
