Skip to content

Latest commit

 

History

History
446 lines (309 loc) · 8.78 KB

README.md

File metadata and controls

446 lines (309 loc) · 8.78 KB
Raw

fume-cli

fume command line interface

oclif Version Codecov Downloads/week License

Usage

$ npm install -g fume-cli
$ fume COMMAND
running command...
$ fume (--version)
fume-cli/1.0.2 darwin-arm64 node-v16.16.0
$ fume --help [COMMAND]
USAGE
  $ fume COMMAND
...

Commands

fume auth:login

Login to fume

USAGE
  $ fume auth:login

DESCRIPTION
  Login to fume

ALIASES
  $ fume login

See code: dist/commands/auth/login.ts

fume auth:logout

Invalidate token and remove credentials

USAGE
  $ fume auth:logout

DESCRIPTION
  Invalidate token and remove credentials

ALIASES
  $ fume logout

See code: dist/commands/auth/logout.ts

fume auth:status

View authentication status

USAGE
  $ fume auth:status

DESCRIPTION
  View authentication status

ALIASES
  $ fume status

See code: dist/commands/auth/status.ts

fume config

Generate a fume.yml config

USAGE
  $ fume config [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Generate a fume.yml config

See code: dist/commands/config.ts

fume deploy [ENVIRONMENT]

Deploy an Environment

USAGE
  $ fume deploy [ENVIRONMENT] [-h]

ARGUMENTS
  ENVIRONMENT  environment to deploy to (ex: staging)

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deploy an Environment

EXAMPLES
  $ fume deploy staging

See code: dist/commands/deploy.ts

fume help [COMMAND]

Display help for fume.

USAGE
  $ fume 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 fume.

See code: @oclif/plugin-help

fume login

Login to fume

USAGE
  $ fume login

DESCRIPTION
  Login to fume

ALIASES
  $ fume login

fume logout

Invalidate token and remove credentials

USAGE
  $ fume logout

DESCRIPTION
  Invalidate token and remove credentials

ALIASES
  $ fume logout

fume plugins

List installed plugins.

USAGE
  $ fume plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ fume plugins

See code: @oclif/plugin-plugins

fume plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ fume plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ fume plugins:add

EXAMPLES
  $ fume plugins:install myplugin 

  $ fume plugins:install https://github.com/someuser/someplugin

  $ fume plugins:install someuser/someplugin

fume plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ fume plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ fume plugins:inspect myplugin

See code: @oclif/plugin-plugins

fume plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ fume plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ fume plugins:add

EXAMPLES
  $ fume plugins:install myplugin 

  $ fume plugins:install https://github.com/someuser/someplugin

  $ fume plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

fume plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ fume plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

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
  $ fume plugins:link myplugin

See code: @oclif/plugin-plugins

fume plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fume plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fume plugins:unlink
  $ fume plugins:remove

fume plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fume plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fume plugins:unlink
  $ fume plugins:remove

See code: @oclif/plugin-plugins

fume plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fume plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fume plugins:unlink
  $ fume plugins:remove

fume plugins:update

Update installed plugins.

USAGE
  $ fume plugins:update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

fume status

View authentication status

USAGE
  $ fume status

DESCRIPTION
  View authentication status

ALIASES
  $ fume status