CLI reference

abx is the command-line interface to the toolkit. Run a command with npx abx <command>. This page groups every command by lane. For the current flags of any command, run npx abx <command> --help.

Deploy and index

Command	Purpose
demo	Deploy a token to testnet, index it, and serve it, as a one-command walkthrough.
deploy	Deploy and index a single 1/1 token.
deploy-series	Deploy a collection from a folder of media: one contract, many tokens.
deploy-code	Deploy a generative or code project.
inspect	Analyze a code project: traits, on-chain reproducibility, dependencies, and a recommended lane.
predict	Compute a deploy address in advance, from the salt, deployer, and factory.
add	Register and index a project this node did not deploy.
index	Re-index from chain. Incremental by default; --full replays from the start.
verify	Re-hash the served bytes and compare them to the on-chain commitment.
render	Render the still image and traits once. Repair lane for code projects.
effects	Run the effects runner locally to render new mints and param changes.
tokenuri	Read tokenURI on-chain and decode the JSON.
serve	Run the resolver: re-index from chain and serve metadata, images, and a dashboard.
state	Print an on-chain snapshot: owner, supply, paused, minter, payee, royalty, renderer.

Sales and ownership

Command	Purpose
mint	Mint a token. The next token, or --count N for a collection.
minter configure	Set price and allocation for a token on the shared fixed-price minter. Optional --erc20.
minter show	Show a token's minter configuration.
minter buy	Buy a token from the fixed-price minter.
set-minter	Authorize the minting contract for a collection.
set-primary-payee	Set the primary-sale payout address.
set-max-invocations	Lower the supply cap. Decreasing only.
pause / unpause	Close or open the mint gate. Owner-only minting while paused.
mint-page	Scaffold a self-contained mint site for the fixed-price minter.
set-royalty	Set the royalty basis points and receiver.
transfer	Transfer or sell a token.

Metadata and hosting config

Command	Purpose
set-token-uri	Re-point a token's metadata URI.
set-contract-uri	Re-point the collection URI.
set-renderer	Toggle URI resolution between on-chain and off-chain.
set-field	Set an on-chain metadata field. Low-level.
attach	Attach a named, typed file to the token's data plane.
lock-field	Freeze a metadata field permanently.
lock-uri	Freeze the URI configuration permanently.
refresh	Ask marketplaces to re-index a token.
set-admin	Transfer contract ownership.
migrate	Move off-chain state to a new resolver, verifying parity before cutover.

Code projects

Command	Purpose
configure-param	Set a governed parameter. Typed, and re-addresses the render.
set-dependency	Declare or replace a code dependency: name@version or an on-chain address.
remove-last-dependency	Remove the last declared dependency.
set-dependency-registry	Point at a dependency registry.
lock-dependencies	Freeze the dependency set.

Storage

Command	Purpose
storage show	Show the resolved byte-custody backend.
storage upload	Upload a file and print its locator.
storage balance	Show Arweave upload credits and the funded address.
storage topup	Buy Arweave upload credits.
storage backup-key	Copy the managed storage key to a path you choose.

Hosting

Command	Purpose
deploy-resolver	Deploy the resolver to a host: fly, render, or a VPS.
deploy-effects	Deploy the effects runner as a hosted service.

Node

Command	Purpose
doctor	Check the environment: RPC, balance, canonical factory, and storage.
status	List indexed projects and node info.
forget	Drop a project's local registration and projection. The chain is untouched.
skill install	Install the ABX agent skill into your agent.
help	Print grouped help, or per-command help with <command> --help.

Signing lanes

Every command that writes to the chain runs in one of three signing lanes:

• --sign: sign in a browser wallet. Nothing is stored.
• --send: sign and broadcast with a hot key from the environment.
• --unsigned: print the raw transaction to sign elsewhere.

Add --dry-run to preview a write without sending it.