Get Started

Up and running
in about 10 minutes.

Install Clams, connect a wallet, and pull your first report. Pair an AI agent if you want to talk to your books in plain language.

Finder File Edit View Go Window Help
9:41 AM

Follow along or skip straight to the steps below.

1

Install Clams

Open your terminal and paste the command below.

Paste into your terminal:

View install script
$ curl -fsSL https://clams.tech/install.sh | sh > powershell -c "irm https://clams.tech/install.ps1 | iex"
You'll be prompted to install Clams Agent Skills. Say yes if you plan to use an AI agent with Clams. Skills are optional but strongly recommended.
Supported platforms: macOS (Apple Silicon and Intel), Linux x86-64 and ARM64 (glibc), and Windows x86-64.

You'll know it worked when…

Restart your terminal, then type clams --version to confirm.

2

Sign in

Run the command below and sign in through your browser.

Paste into your terminal:

You'll know it worked when…

You're signed in and your books are ready to fill.

3

Connect your first wallet

Run the command below and follow the prompts to add your first connection: a Lightning node, an xpub or descriptor, or a CSV import.

Paste into your terminal:

Not sure which connection type fits your wallet? The integrations catalog shows the supported path for each one.

You'll know it worked when…

clams connections list shows your new connection.

4

Sync and pull your first report

Sync your connections, process your journals, and print your first report.

Run these in order:

That's it

Your balance sheet prints in the terminal: real double-entry books from your own data. Portfolio, capital gains, and journal-entry reports are each one command away.

+

Optional: pair an AI agent

Clams ships Agent Skills for AI coding agents: Claude Desktop and Claude Code, Codex, Opencode, and any agent that supports the skills spec. If you said yes to Agent Skills during install, you're already set. Otherwise, run:

Paste into your terminal:

Using Claude? Download Claude Desktop, open the Code tab, and ask: “Help me set up Clams”. Type /clams inside Claude Code to load the skill at any time.

You'll know it worked when…

Your agent answers questions about your books and runs Clams commands for you.

What's next

Going further

For teams or developers who want programmatic access, Clams also has a Server interface, a self-hosted REST API you can deploy on your own infrastructure.

Learn about the Server
Troubleshooting

Common issues

command not found: clams

Restart your terminal and try again. This usually resolves it.

Claude doesn't seem to know about Clams

This usually means the agent skills weren't installed. If you skipped the prompt during installation, open your terminal and run clams skills install --global, then restart Claude Code.

Something else isn't working

Join the Clams Discord community. It's the fastest way to get help.