Skip to content

CompassLabs/compass-agent-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Compass — DeFi skill for AI coding agents

Do on-chain DeFi from your coding agent by delegating to the Compass Labs DeFi API through the compass CLI.

Describe an action in plain English — "supply USDC to Aave", "find the best USDC vault on Base and deposit 100", "open a 2x long on ETH", "buy tokenized TSLA" — and the agent installs the CLI if needed, finds the right command, previews it, runs it, and hands any resulting transaction to your wallet to sign.

Non-custodial: the CLI returns unsigned transactions / EIP-712 typed data. It never holds your keys, signs, or broadcasts.

One skill, multiple agents — the content in skills/compass/ is shared; each agent just has a thin manifest.

Install

Claude Code

/plugin marketplace add CompassLabs/compass-agent-skill
/plugin install compass@compass-labs

Cursor / Codex

This repo ships .cursor-plugin/ and .codex-plugin/ manifests that point at the shared skills/. Install it through your agent's plugin mechanism (point it at this git repo), or copy skills/compass/ into your agent's skills directory.

Any other agent (universal)

Point your agent at AGENTS.md (or GEMINI.md) in this repo — 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.

Use

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

How it works

flowchart TD
    A{"compass installed?"} -->|no| B["Confirm with user, then install"]
    A -->|yes| C["Map intent → command<br/>(compass --usage / group --help)"]
    B --> C
    C --> D["Read the command's flags<br/>(--help or docs)"]
    D --> E["credit / earn / equities?<br/>ensure account exists first"]
    E --> F["Preview with --dry-run"]
    F --> G["Execute"]
    G --> H{"Output is unsigned tx / EIP-712?"}
    H -->|yes action| I["Sign with the user's key via cast<br/>(see Signing and hand-off)"]
    H -->|no read-only| J["Show the result"]
Loading

Requirements

  • A Compass API key: export COMPASS_API_KEY_AUTH=... (get one at https://compasslabs.ai/login).
  • The compass CLI: the skill installs it on first use, or:
    curl -fsSL https://compasslabs.ai/install.sh | bash      # macOS / Linux
    iwr -useb https://compasslabs.ai/install.ps1 | iex       # Windows
    # or
    go install github.com/CompassLabs/cli/cmd/compass@latest

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; query each time.
  • Manage on-chain approvals — your wallet's job (or Permit2 via gas sponsorship).

Layout (for maintainers)

  • skills/compass/ — the skill content, single source of truth.
  • .claude-plugin/, .cursor-plugin/, .codex-plugin/ — per-agent manifests, all pointing at skills/.
  • AGENTS.md, GEMINI.md — generated universal-file representations of the skill (don't edit by hand).

This repo is published from the Compass monorepo via tools/compass-agent-skill/publish.sh; edit the skill there, then re-publish.

Links

About

Compass Labs DeFi skill for AI coding agents — drive the compass CLI for on-chain DeFi (Aave, Morpho, perps, equities, gas-sponsored txs). Non-custodial.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors