Skip to main content

​
Prerequisites

  • Node.js 18 or newer (the CLI is distributed as an npm package).
  • jq (optional but recommended) — the examples in these docs use it to read fields such as agentUuid and tokenAddress out of --json output.

​
Install from npm

The CLI is published as brickken-cli. Install it globally to get the brickken command: 
npm install -g brickken-cli

​
Verify the installation

brickken --version
brickken --help
brickken --version prints the installed package version. brickken --help lists the global options and command groups.

​
Build from source

To build a local checkout instead of installing from npm: 
git clone https://github.com/Brickken/brickken-api-cli.git
cd brickken-api-cli
pnpm install
pnpm build
node dist/index.js --help

​
Next step

Authentication

Set up your private key, RPC URL, and target environment before running commands.