CLI

Install the CLI globally or run it through npx:

npm install --global @artblocks/abx-cli
abx help

Use abx <command> --help for every flag and example. This page is a map, not a second copy of the built-in help.

Start and inspect

Command	Use
`demo`	Deploy, index, and serve a test 1/1
`doctor`	Check Node, RPC, factories, storage, skill version, and optional signing setup
`capabilities`	Print supported project types and irreversible choices
`state`	Read owner-controlled settings and parameter schemas
`verify`	Check canonical deployment, byte commitments, and render freshness
`tokenuri` / `contracturi`	Read committed metadata; `contracturi` follows its URI and `--json` is machine-readable
`tokens`	List token state from the contract
`artifacts`	List served artifacts and current or stale effect output
`status`	Show resolver indexing state
`version` / `help`	Show the installed version or command help

Deploy

Command	Use
`deploy`	Deploy a 1/1 image or single-work edition
`deploy-series`	Deploy an image Series or multi-work image edition
`deploy-code`	Deploy a code Series or code edition
`inspect`	Check a script and recommend a deployment lane
`scaffold solidity`	Create a Foundry workspace for renderers and hooks
`predict`	Predict a deterministic address from a pinned salt
`add` / `index`	Register or index a deployed project
`serve`	Run a local resolver
`render` / `effects`	Render once or run the effects worker

Sell and operate

Command	Use
`mint`	Mint the next token or copies of an edition ID
`minter configure`	Set fixed-price sale terms
`minter show`	Read sale terms
`minter buy`	Buy through the shared fixed-price minter
`mint-page`	Scaffold a small mint site
`submit-app`	Submit a deployed collection to the optional ABX App Store
`pause` / `unpause`	Close or open non-owner minting
`set-minter`	Set the authorized minter
`set-primary-payee`	Set the primary-sale recipient
`set-max-invocations`	Lower the ERC-721 supply cap or edition ID-space cap
`set-max-supply`	Lower an edition ID's copy cap
`set-royalty`	Set royalty receiver and basis points
`set-royalty-cap`	Lower the project's royalty ceiling
`set-transfer-validator`	Manage an enrolled transfer validator
`transfer`	Transfer a token or edition copies
`set-admin`	Transfer project ownership

Metadata and code

Command	Use
`set-field` / `attach`	Set metadata or attach a named artifact
`set-token-uri` / `set-contract-uri`	Change URI pointers
`set-renderer`	Choose onchain or resolver metadata
`set-gateway`	Change the HTTP gateway for IPFS or Arweave locators
`lock-field` / `lock-uri`	Permanently freeze metadata settings
`refresh` / `ping-uri`	Ask indexers to refresh metadata
`preview`	Run a code project locally
`configure-param`	Set a governed parameter
`set-schema` / `retire-param`	Define or permanently retire a parameter
`set-param-hooks` / `lock-param-hooks`	Set or freeze parameter hooks
`set-seed-source`	Change the source for future code-project seeds
`set-dependency` / `remove-last-dependency`	Edit code dependencies
`set-dependency-registry`	Change the dependency registry
`replace-script`	Safely replace an unlocked code project's onchain program
`lock-dependencies` / `lock-script`	Permanently freeze code inputs

Storage and hosting

Command	Use
`storage show`	Show the active byte-storage backend
`storage upload` / `storage status`	Upload bytes or check retrieval
`storage balance` / `storage topup`	Manage Arweave upload credit
`storage backup-key`	Back up the managed storage key
`vacuum`	Inspect or reclaim space in the local SQLite projection
`deploy-contract`	Deploy exact compiled EVM initcode, including custom hooks and renderers
`deploy-resolver` / `deploy-effects`	Deploy self-hosted services
`remote`	Inspect or test a conforming hosted service
`auth login` / `auth logout`	Reuse, create, or revoke the current hosted-service key
`auth wallet`	Provision or show the account's stable creator wallet
`auth keys` / `auth revoke-key`	List active key metadata or revoke an unused key
`feedback`	Preview or file an ABX report; nothing sends without `--yes`
`migrate`	Check parity while moving between resolvers
`forget`	Remove a local or remote projection without touching the chain

Signing lanes

Every write uses one lane:

Flag	Behavior
`--sponsor`	Use an eligible account-bound creator wallet and provider-paid gas
`--sign`	Open a browser wallet
`--send`	Sign with the configured hot key
`--unsigned`	Print an unsigned transaction
`--dry-run`	Simulate without sending

If the creator has not chosen a signer, use the live remote descriptor to prefer sponsorship when the chain and transaction group are eligible. Otherwise choose the appropriate bring-your-own lane. Never paste a private key into a chat or prompt.

A deploy preview reports the wallet approvals it will need. A predicted address is stable only when you reuse the displayed salt with --salt. A salt's first 20 bytes are its deployer guard: they must be zero (permissionless) or the address that will sign. The CLI refuses a known signer/guard mismatch before authorization or broadcast.

Structured deploy plan (`--dry-run --json`)

deploy, deploy-series, and deploy-code include a versioned plan object in JSON output. It contains the signing lane, transaction groups, roles, royalties, custody, mint plan, estimates, warnings, required public surfaces, dependencies, and resume state. Unknown values are null.

transactions.approvals is the number of wallet approvals. transactions.legs names the logical groups they contain. Large code deployments may split setup across transactions. deploy-code --resume continues the idempotent setup steps, and reserve mints run last.

Agent skill and updates

abx skill install installs the version-matched agent skill. abx doctor reports drift between the skill and CLI.

The CLI may print a notice when a newer npm release exists. It never upgrades itself. Set ABX_NO_UPDATE_CHECK=1 to disable the check.

On this page