Skip to main content
The Brickken CLI is the public terminal client for the Dapp API, KYC onboarding, the Sandbox/Forge BKN faucet, and the Agentic API. It supports Dapp API transaction methods through brickken tx, Dapp API JSON endpoints through brickken dapp, ERC-8004 on Base, and ERC-8226 RAMS mandates on Ethereum Sepolia. Client-controlled requests use an API key when configured and otherwise use x402 where supported; relayed sends always use x402.

npm package

Install brickken-cli from npm.

GitHub repository

View the public source repository.

Install

You can also run it without a global install:

Authentication

Dapp API requests and KYC require an API key. Client-controlled Agentic API and RAMS requests use the key when configured and otherwise fall back to x402. Agent getters and the BKN faucet use an API key when configured and support x402 where documented.
BKN_API_KEY and BKN_PRIVATE_KEY are accepted aliases. The private key signs the x402 payment, client-signed transactions, and requested RAMS typed data locally.
With BRICKKEN_API_KEY configured, the CLI can prepare and send Dapp API transaction methods and call Dapp API JSON endpoints. Multipart file uploads such as /patch-token-docs remain REST-only.
Never paste production private keys into shared terminals, tickets, or chat logs. Prefer environment variables or an .env file that is not committed.

Environments

An internal forge environment exists for Brickken pre-release QA — contact tech@brickken.com for its base URL. Override the API base URL directly when needed:

Network and RPC

Pass the target operation chain with --chain. Decimal and hex values are accepted. The Agentic API runs on Base, with Base Sepolia for tests. Some commands, especially create-token --execute, wait for a deployment receipt to recover tokenAddress. Set an RPC URL for that lookup:
BKN_RPC_URL is accepted as an alias, or pass --rpc-url.

Command Model

High-level commands are prepare-only by default. With an API key, client-controlled requests use API-key authentication; without one, eligible Agentic API and RAMS requests use x402. Relayed preparation is free and relayed sends use x402. Add --execute to also send in one step. Add --json for machine-readable output. The recommended path is brickken-relayed mode: pass --execution-mode brickken-relayed and omit --signer-address — Brickken’s relayer signs and broadcasts. The default is client-signed, where you provide --signer-address and the CLI signs the prepared transaction locally.

Commands

See the complete brickken rams command reference and end-to-end mandate workflow. See the Dapp API command reference for authenticated reads and JSON requests, and the raw transaction reference for tokenization and STO methods.

AI Agent Skill

The npm package includes a Brickken skill at skills/brickken, built on the open Agent Skills format and compatible with any agent that supports it — Claude Code, OpenAI Codex, Gemini CLI, Cursor, GitHub Copilot, and more. Use it when an AI agent needs to choose between the Dapp API, Agentic API, CLI, or MCP. For standalone installation without a global CLI install, see the Skill documentation. After installing brickken-cli, install the skill into the default skills directory (~/.codex/skills):
Or pass --path to target your agent’s skills directory (for example ~/.claude/skills for Claude Code, ~/.gemini/skills for Gemini CLI, ~/.cursor/skills for Cursor):
To inspect where the bundled skill lives in the installed package:
Without a global install:

Agent Example

File Input

Use --file for nested JSON/YAML payloads, long metadata, or automation:
Relayed preparation is free and the full operation is x402-priced at send. Client-controlled modes split the operation charge between prepare and send. Fund the wallet behind BRICKKEN_PRIVATE_KEY with enough USDC on the x402 payment chain (e.g. Circle USDC on Base Sepolia). In brickken-relayed mode Brickken’s relayer pays native gas; in client-signed mode you also need native gas on the operation chain.