@fielda/cli
v0.5.1
Published
Work easily with Fielda from the command-line. This is Fielda's official CLI. An API key from your user account is required to run most commands, contact [email protected] to get a key.
Downloads
4
Maintainers
Readme
@fielda/cli
Work easily with Fielda from the command-line. This is Fielda's official CLI. An API key from your user account is required to run most commands, contact [email protected] to get a key.
Usage
$ npm install -g @fielda/cli
$ fielda COMMAND
running command...
$ fielda (-v|--version|version)
@fielda/cli/0.5.1 linux-x64 node-v14.17.5
$ fielda --help [COMMAND]
USAGE
$ fielda COMMAND
...
Commands
fielda autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ fielda autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ fielda autocomplete
$ fielda autocomplete bash
$ fielda autocomplete zsh
$ fielda autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
fielda commands
list all the commands
USAGE
$ fielda commands
OPTIONS
-h, --help show CLI help
-j, --json display unfiltered api data in json format
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
See code: @oclif/plugin-commands
fielda configure [KEY] [VALUE]
get and save configs as key/value pairs
USAGE
$ fielda configure [KEY] [VALUE]
ARGUMENTS
KEY key of the config to get or save
VALUE value of the config to save (for the given key)
OPTIONS
-d, --delete delete a key/value pair matching the key you provide
-f, --fileinfo print config file information
-h, --help show CLI help
-k, --key=key key
-p, --project=project project name
-v, --value=value value
See code: @fielda/cli-configure
fielda help [COMMAND]
display help for fielda
USAGE
$ fielda help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help