cowboy is the command line for building actors, the agents that run on Cowboy, and for deploying, hiring and paying for them. To install it, see Install. To learn it by doing, start with the quickstart.
Every command prints its own help with --help.
Choose a network
Commands use the network you select. Cloud is Cowboy’s main network:cowboy env use cloud
Scripts
Most commands take--json. Script the CLI describes the output and the exit codes.
Commands
Everyday
Build, test and deploy an actor, then work with it.| Command | Description | Subcommands |
|---|---|---|
cowboy init | Create or extend a Cowboy project | |
cowboy check | Check actor source and refresh editor typings | |
cowboy build | Build actor artifacts and off-chain images | |
cowboy run | Run an actor handler locally | |
cowboy test | Run project tests | |
cowboy deploy | Build, publish and fund a project actor, or deploy a workload | |
cowboy verify-deploy | Verify a completed project deployment | |
cowboy actor | Call, inspect, fund, and upgrade actors | interface, update-offchain, call, inspect, state, pins, code, logs, messages, timers, jobs, upgrade, fund, publish-site, owner-funding, auto-topup, transfer-owner, address, manifest-encode |
cowboy env | Select and configure network environments | add, use, list, current |
cowboy wallet | Create and manage wallets | create, address, balance, upgrade, create-mnemonic, import-mnemonic, accounts, export, import-hex |
cowboy account | Inspect accounts and manage their authorization policy and recovery | balance, nonce, info, auth, set-policy, set-recovery, initiate-recovery, cancel-recovery, complete-recovery |
cowboy status | Show network status |
Store and money
Hire and sell in the General Store, and pay for it.| Command | Description | Subcommands |
|---|---|---|
cowboy store | Publish, discover, hire, and manage Store offerings | declaration-id, declare, list, version, current, retire, add, register-store, grant, remove, revoke-grant, use, register-artifact, search, retire-artifact, show, hires, deposit, submit, submissions, withdraw, renew, set-renewal, hire, pause, revoke, status, expire-hire, settle, unpause, sign-per-call-receipt, attest, get-* |
cowboy credit | Claim the one-time new-account credit on bigsky or Cloud | claim |
cowboy topup | Request additional money through a browser link, then wait for the result | |
cowboy transfer | Send CBY to an address | |
cowboy session | Open, fund, and settle payment sessions | force-end, models, open, voucher, deposit, settle, close, finalize, get |
cowboy usage | Read selected Cowboy Labs usage and allowance counters | |
cowboy billing | Read Cowboy Labs membership and billing history, or open its billing page | status, history, open |
cowboy login | Sign in to a Cowboy Labs account with a wallet proof | |
cowboy whoami | Read the selected Cowboy Labs account identity | |
cowboy logout | Revoke the selected Labs session and remove its local credentials | |
cowboy dashboard | Connect a browser signer to Cowboy Labs services | connect |
Secrets and data
Secrets, files, data feeds, tokens and jobs.More
Libraries, rooms, services, and reading the chain.| Command | Description | Subcommands |
|---|---|---|
cowboy workload | Build and manage persistent workload images | init, mount-policy, build, status, stop, start |
cowboy lib | Publish and inspect reusable actor libraries | publish, remove, list, copy |
cowboy cowchat | Manage hosted chat services and encrypted rooms | services, register-service, deregister-service, rooms |
cowboy rooms | Create rooms, add seats, and install native actor routes | suspend, resume, close-session, provision-gateway, trace, inspect, send, prepare-template, seat-id, sign-template, create, add-seat, update-template, bind-consumer, wake-schedule, create-inbox-group, materialize-messages-lane, create-control-lane, deploy-actor |
cowboy block | Inspect blocks | by-height, by-hash, latest, inspect |
cowboy transaction | Inspect transactions and receipts | submit, sign, get, status, inspect |
cowboy faucet | Request development funds from a configured faucet | request |
cowboy version | Show the CLI version | |
cowboy completions | Generate shell completions |
Operators
Run the machines behind the network.Options every command takes
| Option | Description |
|---|---|
--labs-url <ORIGIN> | Exact Cowboy Labs origin, independent of the protocol environment and RPC endpoint. Env: COWBOY_LABS_URL. |
--labs-wallet <ADDRESS> | Labs wallet account to select, otherwise the last login at this origin. Env: COWBOY_LABS_WALLET. |
--rpc-url <RPC_URL> | Node RPC URL for any command; otherwise COWBOY_RPC_URL, the selected environment’s endpoint, then http://localhost:4000. --indexer-url is a legacy alias for this node URL, not a standalone indexer target. Alias: --indexer-url. |
--env <ENV> | Trusted global profile: local, mesa, canyon, bigsky, cloud, or a custom name (dev is legacy Mesa). Otherwise shell COWBOY_ENV, saved project selection, global default, then local. init and deploy remember --env. Env: COWBOY_ENV. |
--private-key <PRIVATE_KEY> | Signing key FILE path for any command that signs (never the key itself); otherwise COWBOY_PRIVATE_KEY_FILE, COWBOY_PRIVATE_KEY, the key selected profile’s key in the keystore (~/.cowboy/keys/<name>, default “default”) |
--request-timeout <SECONDS> | Seconds to wait for each HTTP request to the node (connection through the full answer); replaces every command’s own request timeout. --receipt-timeout still limits how long a receipt wait keeps polling. Env: COWBOY_REQUEST_TIMEOUT. |
--connect-timeout <SECONDS> | Seconds to wait for a connection to the node. Env: COWBOY_CONNECT_TIMEOUT. |
--log-level <LOG_LEVEL> | Log level. Default: info. |
--non-interactive | Never prompt or guess: stop and say what to pass instead. Also COWBOY_NON_INTERACTIVE=1; on automatically when an AI agent is detected (COWBOY_NON_INTERACTIVE=0 turns that off) |
Gas options
Commands that sign a transaction take these to control what it can spend. Leave them out and the CLI works them out, unless the command’s section lists the option with its own default.| Option | Description |
|---|---|
--cycles-limit | Cycles limit. |
--cells-limit | Cells limit. |
--access-limit | Access limit (store I/O operations). |
--max-fee-per-cycle | Max fee per cycle. |
--max-fee-per-cell | Max fee per cell. |
--max-fee-per-access | Max fee per access. |
--max-priority-fee-per-access | Max priority fee per access in wei. Default: 0. |