@atomicsolutions/proton
v2.0.16
Published
Proton Client CLI v2
Downloads
212
Readme
proton-client-cli-v2
Proton Client CLI v2
Usage
$ npm install -g @atomicsolutions/proton
$ proton COMMAND
running command...
$ proton (--version)
@atomicsolutions/proton/2.0.16 linux-x64 node-v20.11.0
$ proton --help [COMMAND]
USAGE
$ proton COMMAND
...
Commands
proton add-connection
proton client-status
proton connect [NAME]
proton disconnect
proton edit-connection [NAME]
proton help [COMMAND]
proton init
proton list
proton list-connections
proton plugins
proton plugins:add PLUGIN
proton plugins:inspect PLUGIN...
proton plugins:install PLUGIN
proton plugins:link PATH
proton plugins:remove [PLUGIN]
proton plugins:reset
proton plugins:uninstall [PLUGIN]
proton plugins:unlink [PLUGIN]
proton plugins:update
proton remove-connection [NAME]
proton settings
proton status
proton stop-run [DATASETRUN]
proton update [CHANNEL]
proton add-connection
Add a new Proton server connection
USAGE
$ proton add-connection [-n <value>] [-s <value>] [-u <value>] [-p <value>]
FLAGS
-n, --name=<value>
-p, --password=<value>
-s, --server=<value>
-u, --username=<value>
DESCRIPTION
Add a new Proton server connection
EXAMPLES
$ proton add-connection
See code: src/commands/add-connection.ts
proton client-status
Display the current client status
USAGE
$ proton client-status
DESCRIPTION
Display the current client status
EXAMPLES
$ proton client-status
See code: src/commands/client-status.ts
proton connect [NAME]
Connect to a Proton server
USAGE
$ proton connect [NAME]
ARGUMENTS
NAME Connection name
DESCRIPTION
Connect to a Proton server
EXAMPLES
$ proton connect
See code: src/commands/connect.ts
proton disconnect
Disconnect from a Proton server
USAGE
$ proton disconnect
DESCRIPTION
Disconnect from a Proton server
EXAMPLES
$ proton disconnect
See code: src/commands/disconnect.ts
proton edit-connection [NAME]
Change the connection configuration
USAGE
$ proton edit-connection [NAME] [-n <value>] [-s <value>] [-u <value>] [-p <value>]
ARGUMENTS
NAME Connection name
FLAGS
-n, --name=<value> Connection name
-p, --password=<value> Password to connect to server
-s, --server=<value> Server URL address
-u, --username=<value> Username to connect to server
DESCRIPTION
Change the connection configuration
EXAMPLES
$ proton edit-connection atomic --name atomic-dev
See code: src/commands/edit-connection.ts
proton help [COMMAND]
Display help for proton.
USAGE
$ proton 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 proton.
See code: @oclif/plugin-help
proton init
Initialize folders and files for proton client CLI
USAGE
$ proton init
DESCRIPTION
Initialize folders and files for proton client CLI
EXAMPLES
$ proton init
See code: src/commands/init.ts
proton list
Display a list of configured connections
USAGE
$ proton list
DESCRIPTION
Display a list of configured connections
EXAMPLES
$ proton list
See code: src/commands/list.ts
proton list-connections
Display a list of configured connections
USAGE
$ proton list-connections
DESCRIPTION
Display a list of configured connections
EXAMPLES
$ proton list-connections
See code: src/commands/list-connections.ts
proton plugins
List installed plugins.
USAGE
$ proton plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ proton plugins
See code: @oclif/plugin-plugins
proton plugins:add PLUGIN
Installs a plugin into proton.
USAGE
$ proton 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 proton.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PROTON_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PROTON_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ proton plugins:add
EXAMPLES
Install a plugin from npm registry.
$ proton plugins:add myplugin
Install a plugin from a github url.
$ proton plugins:add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ proton plugins:add someuser/someplugin
proton plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ proton 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
$ proton plugins:inspect myplugin
See code: @oclif/plugin-plugins
proton plugins:install PLUGIN
Installs a plugin into proton.
USAGE
$ proton 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 proton.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PROTON_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PROTON_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ proton plugins:add
EXAMPLES
Install a plugin from npm registry.
$ proton plugins:install myplugin
Install a plugin from a github url.
$ proton plugins:install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ proton plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
proton plugins:link PATH
Links a plugin into the CLI for development.
USAGE
$ proton 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
$ proton plugins:link myplugin
See code: @oclif/plugin-plugins
proton plugins:remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ proton 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
$ proton plugins:unlink
$ proton plugins:remove
EXAMPLES
$ proton plugins:remove myplugin
proton plugins:reset
Remove all user-installed and linked plugins.
USAGE
$ proton 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
proton plugins:uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ proton 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
$ proton plugins:unlink
$ proton plugins:remove
EXAMPLES
$ proton plugins:uninstall myplugin
See code: @oclif/plugin-plugins
proton plugins:unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ proton 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
$ proton plugins:unlink
$ proton plugins:remove
EXAMPLES
$ proton plugins:unlink myplugin
proton plugins:update
Update installed plugins.
USAGE
$ proton plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
proton remove-connection [NAME]
Remove the selected connection
USAGE
$ proton remove-connection [NAME]
ARGUMENTS
NAME Connection name
DESCRIPTION
Remove the selected connection
EXAMPLES
$ proton remove-connection
See code: src/commands/remove-connection.ts
proton settings
Set or list proton client settings
USAGE
$ proton settings [-m <value>] [-p <value>]
FLAGS
-m, --maven-path=<value> Set maven path
-p, --parallel-runs=<value> How many automations may be run in parallel
DESCRIPTION
Set or list proton client settings
EXAMPLES
$ proton settings
See code: src/commands/settings.ts
proton status
Get the current run list status
USAGE
$ proton status
DESCRIPTION
Get the current run list status
EXAMPLES
$ proton status
See code: src/commands/status.ts
proton stop-run [DATASETRUN]
Stop the selected run
USAGE
$ proton stop-run [DATASETRUN]
ARGUMENTS
DATASETRUN Dataset Run ID
DESCRIPTION
Stop the selected run
EXAMPLES
$ proton stop-run atomic --name atomic-dev
See code: src/commands/stop-run.ts
proton update [CHANNEL]
update the proton CLI
USAGE
$ proton update [CHANNEL] [--force | | [-a | -v <value> | -i]]
FLAGS
-a, --available See available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the proton CLI
EXAMPLES
Update to the stable channel:
$ proton update stable
Update to a specific version:
$ proton update --version 1.0.0
Interactively select version:
$ proton update --interactive
See available versions:
$ proton update --available
See code: @oclif/plugin-update