CLI

The entry point to Stackr SDK

Stackr SDK comes with a CLI that allows you to interact with the SDK from the command line. The CLI is the entry point to the SDK and provides a set of commands to help you manage your projects.

It is written in TypeScript and can be installed globally using npm or yarn.

npm install -g @stackr/cli

Although we recommend using CLI using npx so that you always have the latest version of the CLI.

npx @stackr/cli@latest

running this should display the help message for the CLI like this -

Stackr CLI
 
VERSION
  @stackr/cli/0.1.2 darwin-arm64 node-v20.11.1
 
USAGE
  $ stackr [COMMAND]
 
COMMANDS
  add                 Add a Bridge contract to the AppInbox contract of your MRU
  compile             Compile yours Stackr State Machines to portable WASM modules.
  deploy              Deploy your MRU to Vulcan
  help                Display help for stackr.
  init                Init an MRU from templates
  register            Register your MicroRollup with Stackr
  transfer-ownership  Transfer ownership of the AppInbox contract to a new address
  verify              Verify that the source state machine binary matches with the registered AppInbox binary