scroll-sdk-cli
A tool for managing and testing Scroll SDK deployments
Usage
$ npm install -g scroll-sdk-cli
$ scrollsdk COMMAND
running command...
$ scrollsdk (--version)
scroll-sdk-cli/0.0.2 linux-x64 node-v20.11.0
$ scrollsdk --help [COMMAND]
USAGE
$ scrollsdk COMMAND
...
Commands
scrollsdk help [COMMAND]
Display help for scrollsdk.
USAGE
$ scrollsdk 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 scrollsdk.
See code: @oclif/plugin-help
scrollsdk helper activity
Generate transactions on the specified network(s) to produce more blocks
USAGE
$ scrollsdk helper activity [-c <value>] [-i <value>] [-o] [-t] [-p] [-k <value>] [-x <value>] [-r <value>]
FLAGS
-c, --config=<value> [default: ./config.toml] Path to config.toml file
-i, --interval=<value> [default: 5] Interval between transactions in seconds
-k, --privateKey=<value> Private key (overrides config)
-o, --layer1 Generate activity on Layer 1
-p, --pod Run inside Kubernetes pod
-r, --rpc=<value> RPC URL (overrides config for both layers)
-t, --[no-]layer2 Generate activity on Layer 2
-x, --recipient=<value> Recipient address (overrides config)
DESCRIPTION
Generate transactions on the specified network(s) to produce more blocks
See code: src/commands/helper/activity.ts
scrollsdk helper fund-contracts
Fund L1 and L2 accounts for contracts
USAGE
$ scrollsdk helper fund-contracts [-a <value>] [-c <value>] [-o <value>] [-t <value>] [-d] [-p] [-m] [-k <value>]
FLAGS
-a, --account=<value> Additional account to fund
-c, --config=<value> [default: ./config.toml] Path to config.toml file
-d, --dev Use Anvil devnet funding logic
-k, --private-key=<value> Private key for funder wallet
-m, --manual Manually fund the accounts
-o, --l1rpc=<value> L1 RPC URL
-p, --pod Run inside Kubernetes pod
-t, --l2rpc=<value> L2 RPC URL
DESCRIPTION
Fund L1 and L2 accounts for contracts
See code: src/commands/helper/fund-contracts.ts
scrollsdk plugins
List installed plugins.
USAGE
$ scrollsdk plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ scrollsdk plugins
See code: @oclif/plugin-plugins
scrollsdk plugins add PLUGIN
Installs a plugin into scrollsdk.
USAGE
$ scrollsdk plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into scrollsdk.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SCROLLSDK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SCROLLSDK_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ scrollsdk plugins add
EXAMPLES
Install a plugin from npm registry.
$ scrollsdk plugins add myplugin
Install a plugin from a github url.
$ scrollsdk plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ scrollsdk plugins add someuser/someplugin
scrollsdk plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ scrollsdk plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ scrollsdk plugins inspect myplugin
See code: @oclif/plugin-plugins
scrollsdk plugins install PLUGIN
Installs a plugin into scrollsdk.
USAGE
$ scrollsdk plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into scrollsdk.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SCROLLSDK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SCROLLSDK_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ scrollsdk plugins add
EXAMPLES
Install a plugin from npm registry.
$ scrollsdk plugins install myplugin
Install a plugin from a github url.
$ scrollsdk plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ scrollsdk plugins install someuser/someplugin
See code: @oclif/plugin-plugins
scrollsdk plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ scrollsdk plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ scrollsdk plugins link myplugin
See code: @oclif/plugin-plugins
scrollsdk plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ scrollsdk plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ scrollsdk plugins unlink
$ scrollsdk plugins remove
EXAMPLES
$ scrollsdk plugins remove myplugin
scrollsdk plugins reset
Remove all user-installed and linked plugins.
USAGE
$ scrollsdk plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
scrollsdk plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ scrollsdk plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ scrollsdk plugins unlink
$ scrollsdk plugins remove
EXAMPLES
$ scrollsdk plugins uninstall myplugin
See code: @oclif/plugin-plugins
scrollsdk plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ scrollsdk plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ scrollsdk plugins unlink
$ scrollsdk plugins remove
EXAMPLES
$ scrollsdk plugins unlink myplugin
scrollsdk plugins update
Update installed plugins.
USAGE
$ scrollsdk plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
scrollsdk test contracts
Test contracts by checking deployment and initialization
USAGE
$ scrollsdk test contracts [-c <value>] [-n <value>] [-p]
FLAGS
-c, --config=<value> [default: ./config.toml] Path to config.toml file
-n, --contracts=<value> [default: ./config-contracts.toml] Path to configs-contracts.toml file
-p, --pod Run inside Kubernetes pod
DESCRIPTION
Test contracts by checking deployment and initialization
See code: src/commands/test/contracts.ts
scrollsdk test dependencies
Check for required dependencies
USAGE
$ scrollsdk test dependencies [-d]
FLAGS
-d, --dev Include development dependencies
DESCRIPTION
Check for required dependencies
See code: src/commands/test/dependencies.ts
scrollsdk test e2e
Test contracts by checking deployment and initialization
USAGE
$ scrollsdk test e2e [-c <value>] [-n <value>] [-m] [-p] [-k <value>] [-r] [-s]
FLAGS
-c, --config=<value> [default: ./config.toml] Path to config.toml file
-k, --private-key=<value> Private key for funder wallet initialization
-m, --manual Manually fund the test wallet.
-n, --contracts=<value> [default: ./config-contracts.toml] Path to configs-contracts.toml file
-p, --pod Run inside Kubernetes pod
-r, --resume Uses e2e_resume.json to continue last run.
-s, --skip-wallet-generation Manually fund the test wallet.
DESCRIPTION
Test contracts by checking deployment and initialization
See code: src/commands/test/e2e.ts
scrollsdk test ingress
Check for required ingress hosts
USAGE
$ scrollsdk test ingress [-c <value>] [-d] [-n <value>]
FLAGS
-c, --config=<value> Path to config.toml file
-d, --dev Include development ingresses
-n, --namespace=<value> [default: default] Kubernetes namespace
DESCRIPTION
Check for required ingress hosts
See code: src/commands/test/ingress.ts