Skip to main content

cli

cubist​

Usage: cubist <command>

Multi-chain Web3 development and deployment framework

Commands​

  • new: Create new empty project
  • pre-compile: Generate contract interfaces
  • compile: Compile contracts
  • build: Build (pre-compile + compile + gen)
  • gen: Generate code (for now, defaults to ORM, later will have other options)
  • start: Start a Cubist service (e.g., chains or relayer)
  • stop: Stop a running Cubist service
  • status: Print out the status of running Cubist services

cubist new​

Usage: cubist new [-t|--type] [--template] [--from-repo] [--dir] [--force] [--branch] <NAME>

Create new empty project

Options​

  • <NAME> : Project name

  • -t, --type <TYPE> (default: TypeScript): Project type

    Possible values:

    • JavaScript: JavaScript
    • TypeScript: TypeScript
    • Rust: Rust

  • --template <TEMPLATE>: Create project from template

    Possible values:

    • Storage: Counter running on Polygon and posting on Ethereum
    • MPMC: Multiple producer multiple consumer app running across Avalanche, Ethereum, Polygon, and an Avalanche subnet
    • TokenBridge: Token bridge that bridges wrapped gas tokens from Avalanche to Ethereum

  • --from-repo <GIT_URL>: Create project from git repo template

  • --dir <DIR>: Directory where to create project

  • --force <FORCE>: Force creation (e.g., by overwrite existing files or ignoring non-standard templates)

  • --branch <BRANCH>: Branch to pull from, if creating a project from template

cubist pre-compile​

Usage: cubist pre-compile [-c|--config]

Generate contract interfaces

Options​

  • -c, --config <CONFIG>: Explicit config file

cubist compile​

Usage: cubist compile [-c|--config]

Compile contracts

Options​

  • -c, --config <CONFIG>: Explicit config file

cubist build​

Usage: cubist build [-c|--config]

Build (pre-compile + compile + gen)

Options​

  • -c, --config <CONFIG>: Explicit config file

cubist gen​

Usage: cubist gen [-c|--config]

Generate code (for now, defaults to ORM, later will have other options)

Options​

  • -c, --config <CONFIG>: Explicit config file

cubist start​

Usage: cubist start [-c|--config] [-m|--mode] [command]

Start a Cubist service (e.g., chains or relayer)

Commands​

Options​

  • -c, --config <CONFIG>: Explicit config file

  • -m, --mode <MODE>: How to start this cubist server process

    Possible values:

    • background: Runs in the foreground only until all chains become ready, then exits leving the chains running in the background
    • foreground: Runs in the foreground until interrupted; once interrupted, all chain processes are stopped

cubist start chains​

Usage: cubist start chains

Start chains

cubist start relayer​

Usage: cubist start relayer [-w|--no-watch] [-d|--watch-interval] [-e|--max-events]

Start bridge

Options​

  • -w, --no-watch <NO_WATCH>: Disables watching the filesystem for new deployment receipts and automatically spinning up bridges for them
  • -d, --watch-interval <MILLIS> (default: 500): How often (in milliseconds) to poll the filesystem to check for new deployments
  • -e, --max-events <MAX_EVENTS> (default: 18446744073709551615): Max number of events to process

cubist start axelar​

Usage: cubist start axelar

Start Axelar relayer

cubist stop​

Usage: cubist stop [-c|--config] [-p|--pid] [KIND]

Stop a running Cubist service

Options​

  • -c, --config <CONFIG>: Limit to processes that were started using this config file

  • -p, --pid <PID>: Limit to the process with this process id

  • [KIND] : Limit to processes of this kind

    Possible values:

    • chains: Kind for a cubist chains daemon
    • relayer: Kind for a cubist relayer daemon
    • axelar: Kind for a cubist axelar daemon

cubist status​

Usage: cubist status [-c|--config] [-p|--pid] [-j|--json] [KIND]

Print out the status of running Cubist services

Options​

  • -c, --config <CONFIG>: Limit to processes that were started using this config file

  • -p, --pid <PID>: Limit to the process with this process id

  • [KIND] : Limit to processes of this kind

    Possible values:

    • chains: Kind for a cubist chains daemon
    • relayer: Kind for a cubist relayer daemon
    • axelar: Kind for a cubist axelar daemon

  • -j, --json <JSON>