Skip to Content
Agent Skill, SDK & CLI

Agent Skill, SDK & CLI

Boardwalk ships an executable layer alongside these docs. The Boardwalk agent skill, the @useboardwalk/sdk package, and its boardwalk CLI let a model — or any app — launch a token, contribute to an auction, claim, stake, and vote. The rest of the docs explain what these actions mean; this page covers how to run them.

The SDK and CLI are non-custodial: they never ask for, store, or accept a private key. They produce unsigned transaction calldata (and, for launch metadata, an EIP-712 payload to sign). Your own wallet signs and submits — the same trust boundary as the rest of Boardwalk.

Install

@useboardwalk/sdk is a framework-agnostic TypeScript package. Use it as a library, install the CLI globally, or run the CLI with no install:

npm install @useboardwalk/sdk       # use as a library
npm install -g @useboardwalk/sdk    # install the boardwalk CLI
npx -p @useboardwalk/sdk boardwalk  # run the CLI, no install

Requires Node 18 or newer. Run boardwalk --help, or boardwalk <command> --help, for the flags on any command.

The CLI

The boardwalk CLI turns a request into calldata without writing code. Every transaction command prints an ordered calls array; when an ERC-20 approval is needed it comes first, so the whole batch submits in one approval. Read commands print plain JSON.

The commands, grouped by what they do:

  • Launch — launch, launch-metadata, submit-metadata, and launch-link (a prefilled URL for surfaces with no terminal)
  • Auction — contribute, claim, refund, seed-liquidity
  • BMX staking — stake-bmx, unstake-bmx, handle-rewards
  • Fees & vesting — claim-issuer-fees, claim-referrer-fees, claim-integrator-fees, claim-vested, claim-participation
  • Liquidity & trading — add-liquidity, remove-liquidity, stake-lp, unstake-lp, claim-lp-rewards, swap
  • Vote direction & visibility — vote, cast-visibility
  • Reads — status, launch-cost

launch, contribute, and claim run on Base, Ethereum, Fraxtal, Katana, Ink, and Arbitrum. Base has full feature parity; BMX staking, reward handling, participation claims, and voting are Base-only. Transactions built on Base carry Boardwalk’s ERC-8021  builder code in their calldata, so onchain volume is attributed even when an agent submits it.

The SDK

Under the CLI is the same set of builders, exported for direct use. Each builder takes a viem client, reads what it needs onchain (allowances, burn cost, launch state), and returns ready-to-submit { to, data, value, chainId } calldata for your wallet to sign.

The full command reference, code examples, and exported functions live in the repo:

Agent skill

The package also ships a Boardwalk agent skill that tells an agent when and how to drive the CLI: which command to use, what to check before calling it, and how to submit the calldata safely.

For Cursor, Codex, Gemini CLI, or anything that supports the Agent Skills  format, install it with one command:

npx skills add useboardwalk/boardwalk-sdk

In Claude Code, install it as a plugin instead:

/plugin marketplace add useboardwalk/boardwalk-sdk
/plugin install boardwalk@boardwalk-sdk

The skill calls the CLI through npx, so there’s nothing else to install.

Last updated on
For LLMsDisclosures