@yodata/cli

yodata

yodata cli

• Usage
• Commands

Usage

$ npm install -g @yodata/cli
$ yodata COMMAND
running command...
$ yodata (-v|--version|version)
@yodata/cli/4.0.4 darwin-x64 node-v16.15.1
$ yodata --help [COMMAND]
USAGE
  $ yodata COMMAND
...

Commands

• yodata autocomplete [SHELL]
• yodata check TARGET
• yodata check-parent TARGET
• yodata delete TARGET
• yodata get TARGET [KEY]
• yodata help [COMMAND]
• yodata list [SEARCH]
• yodata plugins
• yodata plugins:inspect PLUGIN...
• yodata plugins:install PLUGIN...
• yodata plugins:link PLUGIN
• yodata plugins:uninstall PLUGIN...
• yodata plugins:update
• yodata register
• yodata remove NAME
• yodata repost SOURCE DEST
• yodata set TARGET KEY [VALUE]
• yodata touch TARGET
• yodata use PROFILE
• yodata whoami

yodata autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ yodata autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ yodata autocomplete
  $ yodata autocomplete bash
  $ yodata autocomplete zsh
  $ yodata autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

yodata check TARGET

Checks validity of a profile resource

USAGE
  $ yodata check TARGET

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --profile=profile                  [default: solid-dev-bhhs] command context

yodata check-parent TARGET

Checks that target.parentOrganization contains target and optionally fixes it.

USAGE
  $ yodata check-parent TARGET

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output

  --domain=domain                    [default: .bhhs.hsfaffiliates.com/profile/card#me] use the domain to construct the
                                     profile id

  --fix                              fix add child to parent if missing

  --profile=profile                  [default: solid-dev-bhhs] command context

yodata delete TARGET

HTTP DELETE pod resource

USAGE
  $ yodata delete TARGET

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  -v, --verbose                      show verbose output i.e HTTP DELETE https://id.example.com/resource 204
  --profile=profile                  [default: solid-dev-bhhs] command context

yodata get TARGET [KEY]

HTTP GET pod resource

USAGE
  $ yodata get TARGET [KEY]

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --each=each                        if response is an array, return this key for each value
  --path=path                        overwrides the default path to target
  --profile=profile                  [default: solid-dev-bhhs] command context

yodata help [COMMAND]

display help for yodata

USAGE
  $ yodata help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

yodata list [SEARCH]

List registered profiles.

USAGE
  $ yodata list [SEARCH]

ARGUMENTS
  SEARCH  only list pods that match search.

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --profile=profile                  [default: solid-dev-bhhs] command context

ALIASES
  $ yodata ls

yodata plugins

list installed plugins

USAGE
  $ yodata plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ yodata plugins

See code: @oclif/plugin-plugins

yodata plugins:inspect PLUGIN...

displays installation properties of a plugin

USAGE
  $ yodata plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] plugin to inspect

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

EXAMPLE
  $ yodata plugins:inspect myplugin

See code: @oclif/plugin-plugins

yodata plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ yodata plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  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
  $ yodata plugins:add

EXAMPLES
  $ yodata plugins:install myplugin 
  $ yodata plugins:install https://github.com/someuser/someplugin
  $ yodata plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

yodata plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ yodata plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  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.

EXAMPLE
  $ yodata plugins:link myplugin

See code: @oclif/plugin-plugins

yodata plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ yodata plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ yodata plugins:unlink
  $ yodata plugins:remove

See code: @oclif/plugin-plugins

yodata plugins:update

update installed plugins

USAGE
  $ yodata plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins

yodata register

Add a new profile.

USAGE
  $ yodata register

yodata remove NAME

Remove a profile

USAGE
  $ yodata remove NAME

ARGUMENTS
  NAME  profile to be removed

yodata repost SOURCE DEST

Gets source and POST to dest, optionally delete the source after

USAGE
  $ yodata repost SOURCE DEST

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --profile=profile                  [default: solid-dev-bhhs] command context

yodata set TARGET KEY [VALUE]

Update a key value in an online JSON document

USAGE
  $ yodata set TARGET KEY [VALUE]

OPTIONS
  -C, --cleararray                   remove all values from an array
  -f, --force                        force create resource if it does not already exist.
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --path=path                        overwrides the default path to target
  --profile=profile                  [default: solid-dev-bhhs] command context

yodata touch TARGET

HTTP GET/PUT a resource.

USAGE
  $ yodata touch TARGET

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --path=path                        overwrides the default path to target
  --profile=profile                  [default: solid-dev-bhhs] command context

yodata use PROFILE

Switch the active pod.

USAGE
  $ yodata use PROFILE

ARGUMENTS
  PROFILE  registered pod name

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --profile=profile                  [default: solid-dev-bhhs] command context

yodata whoami

Get the current profile name

USAGE
  $ yodata whoami

OPTIONS
  -o, --output=yaml|json|table|text  [default: yaml] format output
  --profile=profile                  [default: solid-dev-bhhs] command context

ALIASES
  $ yodata who