statemeshcli
v2.1.3
Published
StateMesh CLI
Readme
smcli
StateMesh CLI
Usage
$ npm install -g statemeshcli
$ smcli COMMAND
running command...
$ smcli (--version)
statemeshcli/2.1.3 linux-x64 node-v20.5.0
$ smcli --help [COMMAND]
USAGE
$ smcli COMMAND
...Commands
smcli apps copysmcli apps deletesmcli apps deploysmcli apps infosmcli apps installsmcli apps listsmcli apps logssmcli apps restartsmcli apps scalesmcli apps startsmcli apps stopsmcli apps terminalsmcli auth loginsmcli auth logoutsmcli auth whoamismcli copysmcli cpsmcli deletesmcli deploysmcli help [COMMAND]smcli infosmcli installsmcli joinsmcli leavesmcli listsmcli loginsmcli logoutsmcli logssmcli node joinsmcli node leavesmcli pluginssmcli plugins add PLUGINsmcli plugins:inspect PLUGIN...smcli plugins install PLUGINsmcli plugins link PATHsmcli plugins remove [PLUGIN]smcli plugins resetsmcli plugins uninstall [PLUGIN]smcli plugins unlink [PLUGIN]smcli plugins updatesmcli restartsmcli scalesmcli startsmcli stopsmcli terminalsmcli whoami
smcli apps copy
copy files to and from app containers
USAGE
$ smcli apps copy [LOCALPATH] --id <value> --path <value> [--cid <value>] [--localPath <value>]
FLAGS
--cid=<value> id of your container
--id=<value> (required) id of your application
--localPath=<value> local path for the downloaded file
--path=<value> (required) path inside the container
DESCRIPTION
copy files to and from app containers
ALIASES
$ smcli copy
$ smcli cpSee code: src/commands/apps/copy.ts
smcli apps delete
delete an application
USAGE
$ smcli apps delete [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
delete an application
ALIASES
$ smcli deleteSee code: src/commands/apps/delete.ts
smcli apps deploy
deploy to StateMesh
USAGE
$ smcli apps deploy [APPNAME] [--appName <value>] [--port <value>] [--repository <value>] [--subPath <value>]
FLAGS
--appName=<value> name of your application
--port=<value> port exposed by your app for web ingress
--repository=<value> public github.com repository of your application
--subPath=<value> directory inside your repository to build
DESCRIPTION
deploy to StateMesh
ALIASES
$ smcli deploySee code: src/commands/apps/deploy.ts
smcli apps info
information about an application
USAGE
$ smcli apps info [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
information about an application
ALIASES
$ smcli infoSee code: src/commands/apps/info.ts
smcli apps install
install DockerHub image to StateMesh
USAGE
$ smcli apps install [APPNAME] [--appName <value>] [--port <value>] [--image <value>] [--tag <value>]
FLAGS
--appName=<value> name of your application
--image=<value> public DockerHub image of your application (Required)
--port=<value> port exposed by your app for web ingress
--tag=<value> tag of the image (default: latest)
DESCRIPTION
install DockerHub image to StateMesh
ALIASES
$ smcli installSee code: src/commands/apps/install.ts
smcli apps list
list applications
USAGE
$ smcli apps list
DESCRIPTION
list applications
ALIASES
$ smcli listSee code: src/commands/apps/list.ts
smcli apps logs
view application logs
USAGE
$ smcli apps logs [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
view application logs
ALIASES
$ smcli logsSee code: src/commands/apps/logs.ts
smcli apps restart
rolling restart an application
USAGE
$ smcli apps restart [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
rolling restart an application
ALIASES
$ smcli restartSee code: src/commands/apps/restart.ts
smcli apps scale
scale an application
USAGE
$ smcli apps scale [ID] --replicas <value> [--id <value>]
FLAGS
--id=<value> id of your application
--replicas=<value> (required) number of replicas [0-4]
DESCRIPTION
scale an application
ALIASES
$ smcli scaleSee code: src/commands/apps/scale.ts
smcli apps start
start an application
USAGE
$ smcli apps start [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
start an application
ALIASES
$ smcli startSee code: src/commands/apps/start.ts
smcli apps stop
stop an application
USAGE
$ smcli apps stop [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
stop an application
ALIASES
$ smcli stopSee code: src/commands/apps/stop.ts
smcli apps terminal
connect to application terminal
USAGE
$ smcli apps terminal [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
connect to application terminal
ALIASES
$ smcli terminalSee code: src/commands/apps/terminal.ts
smcli auth login
login with your StateMesh credentials
USAGE
$ smcli auth login [--browser <value>] [-i]
FLAGS
-i, --interactive login with username/password
--browser=<value> browser to open Login with (example: "firefox", "safari")
DESCRIPTION
login with your StateMesh credentials
ALIASES
$ smcli loginSee code: src/commands/auth/login.ts
smcli auth logout
clears local login credentials
USAGE
$ smcli auth logout
DESCRIPTION
clears local login credentials
ALIASES
$ smcli logoutSee code: src/commands/auth/logout.ts
smcli auth whoami
display the current logged in user
USAGE
$ smcli auth whoami
DESCRIPTION
display the current logged in user
ALIASES
$ smcli whoamiSee code: src/commands/auth/whoami.ts
smcli copy
copy files to and from app containers
USAGE
$ smcli copy [LOCALPATH] --id <value> --path <value> [--cid <value>] [--localPath <value>]
FLAGS
--cid=<value> id of your container
--id=<value> (required) id of your application
--localPath=<value> local path for the downloaded file
--path=<value> (required) path inside the container
DESCRIPTION
copy files to and from app containers
ALIASES
$ smcli copy
$ smcli cpsmcli cp
copy files to and from app containers
USAGE
$ smcli cp [LOCALPATH] --id <value> --path <value> [--cid <value>] [--localPath <value>]
FLAGS
--cid=<value> id of your container
--id=<value> (required) id of your application
--localPath=<value> local path for the downloaded file
--path=<value> (required) path inside the container
DESCRIPTION
copy files to and from app containers
ALIASES
$ smcli copy
$ smcli cpsmcli delete
delete an application
USAGE
$ smcli delete [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
delete an application
ALIASES
$ smcli deletesmcli deploy
deploy to StateMesh
USAGE
$ smcli deploy [APPNAME] [--appName <value>] [--port <value>] [--repository <value>] [--subPath <value>]
FLAGS
--appName=<value> name of your application
--port=<value> port exposed by your app for web ingress
--repository=<value> public github.com repository of your application
--subPath=<value> directory inside your repository to build
DESCRIPTION
deploy to StateMesh
ALIASES
$ smcli deploysmcli help [COMMAND]
Display help for smcli.
USAGE
$ smcli 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 smcli.See code: @oclif/plugin-help
smcli info
information about an application
USAGE
$ smcli info [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
information about an application
ALIASES
$ smcli infosmcli install
install DockerHub image to StateMesh
USAGE
$ smcli install [APPNAME] [--appName <value>] [--port <value>] [--image <value>] [--tag <value>]
FLAGS
--appName=<value> name of your application
--image=<value> public DockerHub image of your application (Required)
--port=<value> port exposed by your app for web ingress
--tag=<value> tag of the image (default: latest)
DESCRIPTION
install DockerHub image to StateMesh
ALIASES
$ smcli installsmcli join
add this device to StateMesh network and become a node operator
USAGE
$ smcli join
DESCRIPTION
add this device to StateMesh network and become a node operator
ALIASES
$ smcli joinsmcli leave
remove this device from StateMesh network
USAGE
$ smcli leave
DESCRIPTION
remove this device from StateMesh network
ALIASES
$ smcli leavesmcli list
list applications
USAGE
$ smcli list
DESCRIPTION
list applications
ALIASES
$ smcli listsmcli login
login with your StateMesh credentials
USAGE
$ smcli login [--browser <value>] [-i]
FLAGS
-i, --interactive login with username/password
--browser=<value> browser to open Login with (example: "firefox", "safari")
DESCRIPTION
login with your StateMesh credentials
ALIASES
$ smcli loginsmcli logout
clears local login credentials
USAGE
$ smcli logout
DESCRIPTION
clears local login credentials
ALIASES
$ smcli logoutsmcli logs
view application logs
USAGE
$ smcli logs [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
view application logs
ALIASES
$ smcli logssmcli node join
add this device to StateMesh network and become a node operator
USAGE
$ smcli node join
DESCRIPTION
add this device to StateMesh network and become a node operator
ALIASES
$ smcli joinSee code: src/commands/node/join.ts
smcli node leave
remove this device from StateMesh network
USAGE
$ smcli node leave
DESCRIPTION
remove this device from StateMesh network
ALIASES
$ smcli leaveSee code: src/commands/node/leave.ts
smcli plugins
List installed plugins.
USAGE
$ smcli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ smcli pluginsSee code: @oclif/plugin-plugins
smcli plugins add PLUGIN
Installs a plugin into smcli.
USAGE
$ smcli 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 smcli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SMCLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SMCLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ smcli plugins add
EXAMPLES
Install a plugin from npm registry.
$ smcli plugins add myplugin
Install a plugin from a github url.
$ smcli plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ smcli plugins add someuser/somepluginsmcli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ smcli 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
$ smcli plugins inspect mypluginSee code: @oclif/plugin-plugins
smcli plugins install PLUGIN
Installs a plugin into smcli.
USAGE
$ smcli 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 smcli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SMCLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SMCLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ smcli plugins add
EXAMPLES
Install a plugin from npm registry.
$ smcli plugins install myplugin
Install a plugin from a github url.
$ smcli plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ smcli plugins install someuser/somepluginSee code: @oclif/plugin-plugins
smcli plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ smcli 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
$ smcli plugins link mypluginSee code: @oclif/plugin-plugins
smcli plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ smcli 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
$ smcli plugins unlink
$ smcli plugins remove
EXAMPLES
$ smcli plugins remove mypluginsmcli plugins reset
Remove all user-installed and linked plugins.
USAGE
$ smcli 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
smcli plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ smcli 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
$ smcli plugins unlink
$ smcli plugins remove
EXAMPLES
$ smcli plugins uninstall mypluginSee code: @oclif/plugin-plugins
smcli plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ smcli 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
$ smcli plugins unlink
$ smcli plugins remove
EXAMPLES
$ smcli plugins unlink mypluginsmcli plugins update
Update installed plugins.
USAGE
$ smcli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
smcli restart
rolling restart an application
USAGE
$ smcli restart [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
rolling restart an application
ALIASES
$ smcli restartsmcli scale
scale an application
USAGE
$ smcli scale [ID] --replicas <value> [--id <value>]
FLAGS
--id=<value> id of your application
--replicas=<value> (required) number of replicas [0-4]
DESCRIPTION
scale an application
ALIASES
$ smcli scalesmcli start
start an application
USAGE
$ smcli start [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
start an application
ALIASES
$ smcli startsmcli stop
stop an application
USAGE
$ smcli stop [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
stop an application
ALIASES
$ smcli stopsmcli terminal
connect to application terminal
USAGE
$ smcli terminal [ID] [--id <value>]
FLAGS
--id=<value> id of your application
DESCRIPTION
connect to application terminal
ALIASES
$ smcli terminalsmcli whoami
display the current logged in user
USAGE
$ smcli whoami
DESCRIPTION
display the current logged in user
ALIASES
$ smcli whoami