npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stackr/cli

v0.1.8

Published

Stackr CLI

Downloads

46

Readme

@stackr/cli

CLI to register, compile and deploy your Stackr Micro Rollups

Usage

$ npm install -g @stackr/cli
$ stackr COMMAND
running command...
$ stackr (--version)
@stackr/cli/0.1.8 linux-x64 node-v18.20.4
$ stackr --help [COMMAND]
USAGE
  $ stackr COMMAND
...

Commands

stackr add [ENTITY] [CONTRACT]

Adds Bridge contract to the AppInbox contract of your MRU

USAGE
  $ stackr add [ENTITY] [CONTRACT] [--envFile <value>]

ARGUMENTS
  ENTITY    (bridge) Entity to add to your App Inbox
  CONTRACT  Contract Address of the entity to add to your App Inbox

FLAGS
  --envFile=<value>  [default: .env] Path to the .env file

DESCRIPTION
  Adds Bridge contract to the AppInbox contract of your MRU

EXAMPLES
  $ stackr add bridge 0x1234567890abcdef1234567890abcdef12345678

  $ stackr add bridge 0x1234567890abcdef1234567890abcdef12345678 --envFile=<relative path to file>

See code: src/commands/add/index.ts

stackr compile

Compile yours Stackr State Machines to portable WASM modules.

USAGE
  $ stackr compile [--skipLintChecks]

FLAGS
  --skipLintChecks  Whether to skip lint checks before compiling (default: false)

DESCRIPTION
  Compile yours Stackr State Machines to portable WASM modules.

EXAMPLES
  $ stackr compile

See code: src/commands/compile/index.ts

stackr deploy

Deploy your MRU to Vulcan

USAGE
  $ stackr deploy [--envFile <value>] [--privateKey <value>]

FLAGS
  --envFile=<value>     [default: .env] Path to the .env file
  --privateKey=<value>  Private key of the account to be used to deploy the contract

DESCRIPTION
  Deploy your MRU to Vulcan

EXAMPLES
  $ stackr deploy

  $ stackr deploy --privateKey <privateKey>

See code: src/commands/deploy/index.ts

stackr help [COMMAND]

Display help for stackr.

USAGE
  $ stackr help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for stackr.

See code: @oclif/plugin-help

stackr init [PROJECTNAME]

Init an MRU from templates

USAGE
  $ stackr init [PROJECTNAME]

DESCRIPTION
  Init an MRU from templates

EXAMPLES
  $ stackr init

See code: src/commands/init/index.ts

stackr register

Register your MicroRollup with Stackr

USAGE
  $ stackr register [--envFile <value>] [--privateKey <value>]

FLAGS
  --envFile=<value>     [default: .env] Path to the .env file
  --privateKey=<value>  Private key of the account to be used to register the contract

DESCRIPTION
  Register your MicroRollup with Stackr

EXAMPLES
  $ stackr register

  $ stackr register --privateKey <privateKey> --envFile <path>

See code: src/commands/register/index.ts

stackr transfer-ownership [NEWOWNER]

Transfer ownership of the AppInbox contract to a new address

USAGE
  $ stackr transfer-ownership [NEWOWNER] [--envFile <value>] [--privateKey <value>]

ARGUMENTS
  NEWOWNER  Address of the new owner of the contract

FLAGS
  --envFile=<value>     [default: .env] Path to the .env file
  --privateKey=<value>  Private key of the current owner of the contract

DESCRIPTION
  Transfer ownership of the AppInbox contract to a new address

EXAMPLES
  $ stackr transfer-ownership <new-address>

  $ stackr transfer-ownership <new-address> --privateKey <privateKey>

  $ stackr transfer-ownership <new-address> --envFile <relative path to file>

See code: src/commands/transfer-ownership/index.ts

stackr verify [APPINBOXCONTRACT]

Verify that the source state machine binary matches with the registered binary on AppInbox

USAGE
  $ stackr verify [APPINBOXCONTRACT]

ARGUMENTS
  APPINBOXCONTRACT  The address of the AppInbox contract. If not provided, the address will be read from the
                    deployment.json file.

DESCRIPTION
  Verify that the source state machine binary matches with the registered binary on AppInbox

EXAMPLES
  $ stackr verify

  $ stackr verify 0x1234567890abcdef1234567890abcdef12345678

See code: src/commands/verify/index.ts