@loopscale/loopscale-cli
v0.0.0
Published
A CLI for interacting with Loopscale Protocol
Downloads
42
Keywords
Readme
loopscale-cli
A CLI for interacting with Loopscale Protocol
Usage
$ npm install -g @loopscale/loopscale-cli
$ loopscale COMMAND
running command...
$ loopscale (--version)
@loopscale/loopscale-cli/0.0.0 darwin-arm64 node-v24.10.0
$ loopscale --help [COMMAND]
USAGE
$ loopscale COMMAND
...Commands
loopscale help [COMMAND]loopscale pluginsloopscale plugins add PLUGINloopscale plugins:inspect PLUGIN...loopscale plugins install PLUGINloopscale plugins link PATHloopscale plugins remove [PLUGIN]loopscale plugins resetloopscale plugins uninstall [PLUGIN]loopscale plugins unlink [PLUGIN]loopscale plugins updateloopscale tx vault depositloopscale tx vault withdraw
loopscale help [COMMAND]
Display help for loopscale.
USAGE
$ loopscale 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 loopscale.See code: @oclif/plugin-help
loopscale plugins
List installed plugins.
USAGE
$ loopscale plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ loopscale pluginsSee code: @oclif/plugin-plugins
loopscale plugins add PLUGIN
Installs a plugin into loopscale.
USAGE
$ loopscale 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 loopscale.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the LOOPSCALE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the LOOPSCALE_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ loopscale plugins add
EXAMPLES
Install a plugin from npm registry.
$ loopscale plugins add myplugin
Install a plugin from a github url.
$ loopscale plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ loopscale plugins add someuser/somepluginloopscale plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ loopscale 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
$ loopscale plugins inspect mypluginSee code: @oclif/plugin-plugins
loopscale plugins install PLUGIN
Installs a plugin into loopscale.
USAGE
$ loopscale 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 loopscale.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the LOOPSCALE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the LOOPSCALE_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ loopscale plugins add
EXAMPLES
Install a plugin from npm registry.
$ loopscale plugins install myplugin
Install a plugin from a github url.
$ loopscale plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ loopscale plugins install someuser/somepluginSee code: @oclif/plugin-plugins
loopscale plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ loopscale 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
$ loopscale plugins link mypluginSee code: @oclif/plugin-plugins
loopscale plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ loopscale 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
$ loopscale plugins unlink
$ loopscale plugins remove
EXAMPLES
$ loopscale plugins remove mypluginloopscale plugins reset
Remove all user-installed and linked plugins.
USAGE
$ loopscale 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
loopscale plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ loopscale 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
$ loopscale plugins unlink
$ loopscale plugins remove
EXAMPLES
$ loopscale plugins uninstall mypluginSee code: @oclif/plugin-plugins
loopscale plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ loopscale 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
$ loopscale plugins unlink
$ loopscale plugins remove
EXAMPLES
$ loopscale plugins unlink mypluginloopscale plugins update
Update installed plugins.
USAGE
$ loopscale plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
loopscale tx vault deposit
Fetch, sign, and submit a Loopscale vault deposit
USAGE
$ loopscale tx vault deposit -a <value> -k <value> -v <value> [--minLp <value>] [-r <value>]
FLAGS
-a, --amount=<value> (required) Principal amount (in lamports/raw units)
-k, --keypair=<value> (required) Path to keypair JSON
-r, --rpc=<value> [default: https://api.mainnet-beta.solana.com] RPC URL used for sending transactions
-v, --vault=<value> (required) Vault address
--minLp=<value> Minimum LP amount
DESCRIPTION
Fetch, sign, and submit a Loopscale vault depositSee code: src/commands/tx/vault/deposit.ts
loopscale tx vault withdraw
Fetch, sign, and submit a Loopscale vault withdrawal
USAGE
$ loopscale tx vault withdraw -a <value> -k <value> -v <value> [--maxLp <value>] [-r <value>] [--withdrawAll]
FLAGS
-a, --amount=<value> (required) Principal amount (in lamports/raw units)
-k, --keypair=<value> (required) Path to keypair JSON
-r, --rpc=<value> [default: https://api.mainnet-beta.solana.com] RPC URL used for sending transactions
-v, --vault=<value> (required) Vault address
--maxLp=<value> Maximum LP amount to burn
--withdrawAll Withdraw full position, override any dust interest.
DESCRIPTION
Fetch, sign, and submit a Loopscale vault withdrawalSee code: src/commands/tx/vault/withdraw.ts
