Skip to main content
The ankara CLI is a thin, interactive wrapper around the Ankara Chain SDK. Instead of writing deployment scripts by hand, you run a single command and answer prompts — the CLI constructs the transaction, submits it through your configured network, and saves the result to ankara.config.json so every subsequent command knows which contracts you own.

Installation

You can use the CLI without a global install, or add it to your project permanently.
Node.js 18 or later is required. Run node --version to check.

Configuration: ankara.config.json

Running ankara init generates an ankara.config.json file in your project root. This file is the source of truth for every CLI command — it tells the CLI which network to target, which factory contracts are deployed, and which tokens you have already issued. After running ankara init and ankara deploy-factory, your config file will look similar to this:
Commit ankara.config.json to version control — it contains no secrets and is safe to share with your team. Each developer uses their own .env for signing keys.

Environment Variables

The CLI reads signing credentials from a .env file in your project root. You need exactly one of the following variables set, depending on your target network.
Never commit your .env file. ankara init automatically adds .env to your .gitignore, but verify this before your first git push. Anyone who obtains your private key has full control of your deployer wallet and every contract it owns.

Command Categories

The CLI groups its commands into eight functional areas. Use this table to find the right command for your task, then see the Commands reference for full flag and option details.

Next Steps

Commands Reference

Full flags, arguments, and example output for every ankara command.

MCP Server

Deploy tokens and manage escrow through Claude and other AI assistants.