attic-cli

• Usage
• Commands

Usage

$ npm install -g @znetstar/attic-cli
$ attic-cli COMMAND
running command...
$ attic-cli (-v|--version|version)
@znetstar/attic-cli/3.14.0 darwin-x64 node-v14.18.3
$ attic-cli --help [COMMAND]
USAGE
  $ attic-cli COMMAND
...

Commands

• attic-cli auth:login
• attic-cli clients:create [FIELDS]
• attic-cli clients:delete [QUERY]
• attic-cli clients:find [QUERY]
• attic-cli clients:search [TERMS]
• attic-cli clients:update
• attic-cli drivers:listTypes
• attic-cli entities:create [FIELDS]
• attic-cli entities:delete [QUERY]
• attic-cli entities:find [QUERY]
• attic-cli entities:listTypes
• attic-cli entities:search [TERMS]
• attic-cli entities:update
• attic-cli help [COMMAND]
• attic-cli locations:create [FIELDS]
• attic-cli locations:delete [QUERY]
• attic-cli locations:find [QUERY]
• attic-cli locations:search [TERMS]
• attic-cli locations:update
• attic-cli plugins
• attic-cli plugins:inspect PLUGIN...
• attic-cli plugins:install PLUGIN...
• attic-cli plugins:link PLUGIN
• attic-cli plugins:uninstall PLUGIN...
• attic-cli plugins:update
• attic-cli resolve:entity [ENTITY]
• attic-cli resolve:location [LOCATION]
• attic-cli resolvers:create [FIELDS]
• attic-cli resolvers:delete [QUERY]
• attic-cli resolvers:find [QUERY]
• attic-cli resolvers:listTypes
• attic-cli resolvers:search [TERMS]
• attic-cli resolvers:update
• attic-cli rpc
• attic-cli shortUrl
• attic-cli users:create [FIELDS]
• attic-cli users:delete [QUERY]
• attic-cli users:find [QUERY]
• attic-cli users:search [TERMS]
• attic-cli users:update

attic-cli auth:login

attempts to log in with provided credentials

USAGE
  $ attic-cli auth:login

OPTIONS
  -h, --help                       show CLI help
  -i, --clientId=clientId          (required) [default: attic]
  -s, --clientSecret=clientSecret  (required) [default: attic]
  -u, --username=username          [default: root]
  -v, --verbose
  --format=(text|json)             [default: text]
  --scope=scope                    [default: .*,group.service]

ALIASES
  $ attic-cli login

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

attic-cli clients:create [FIELDS]

creates a location, returning the url and id

USAGE
  $ attic-cli clients:create [FIELDS]

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help                 show CLI help
  -r, --href=href            (required)
  -s, --short
  -u, --auth=auth
  -v, --verbose
  -x, --expiresIn=expiresIn
  --format=(text|json)       [default: text]

See code: src/commands/clients/create.ts

attic-cli clients:delete [QUERY]

deletes a location

USAGE
  $ attic-cli clients:delete [QUERY]

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help            show CLI help
  -i, --id=id
  -l, --limit=limit
  -o, --sort=sort
  -r, --href=href
  -s, --skip=skip
  -u, --auth=auth
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/clients/delete.ts

attic-cli clients:find [QUERY]

finds a location via MongoDB query

USAGE
  $ attic-cli clients:find [QUERY]

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help            show CLI help
  -i, --id=id
  -l, --limit=limit
  -o, --sort=sort
  -r, --href=href
  -s, --skip=skip
  -u, --auth=auth
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/clients/find.ts

attic-cli clients:search [TERMS]

searches for an entity via MongoDB text search

USAGE
  $ attic-cli clients:search [TERMS]

OPTIONS
  -c, --count
  -h, --help            show CLI help
  -l, --limit=limit
  -s, --skip=skip
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/clients/search.ts

attic-cli clients:update

updates an existing location, returning the url and id

USAGE
  $ attic-cli clients:update

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help                 show CLI help
  -i, --id=id                (required)
  -r, --href=href
  -s, --short
  -u, --auth=auth
  -v, --verbose
  -x, --expiresIn=expiresIn
  --format=(text|json)       [default: text]

See code: src/commands/clients/update.ts

attic-cli drivers:listTypes

lists all available driver types

USAGE
  $ attic-cli drivers:listTypes

OPTIONS
  -h, --help            show CLI help
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/drivers/listTypes.ts

attic-cli entities:create [FIELDS]

creates a entity returning a entity id

USAGE
  $ attic-cli entities:create [FIELDS]

OPTIONS
  -h, --help            show CLI help
  -s, --source=source   (required)
  -t, --type=type
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/entities/create.ts

attic-cli entities:delete [QUERY]

deletes an entity

USAGE
  $ attic-cli entities:delete [QUERY]

OPTIONS
  -h, --help            show CLI help
  -i, --id=id
  -s, --source=source   (required)
  -t, --type=type
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/entities/delete.ts

attic-cli entities:find [QUERY]

finds an entity via MongoDB query

USAGE
  $ attic-cli entities:find [QUERY]

OPTIONS
  -h, --help            show CLI help
  -i, --id=id
  -s, --source=source
  -t, --type=type
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/entities/find.ts

attic-cli entities:listTypes

lists all entity types

USAGE
  $ attic-cli entities:listTypes

OPTIONS
  -h, --help            show CLI help
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/entities/listTypes.ts

attic-cli entities:search [TERMS]

searches an entity via MongoDB text query

USAGE
  $ attic-cli entities:search [TERMS]

OPTIONS
  -c, --count
  -h, --help            show CLI help
  -l, --limit=limit
  -s, --skip=skip
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/entities/search.ts

attic-cli entities:update

updates an existing entity

USAGE
  $ attic-cli entities:update

OPTIONS
  -h, --help            show CLI help
  -i, --id=id           (required)
  -s, --source=source   (required)
  -t, --type=type
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/entities/update.ts

attic-cli help [COMMAND]

display help for attic-cli

USAGE
  $ attic-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

attic-cli locations:create [FIELDS]

creates a location, returning the url and id

USAGE
  $ attic-cli locations:create [FIELDS]

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help                 show CLI help
  -r, --href=href            (required)
  -s, --short
  -u, --auth=auth
  -v, --verbose
  -x, --expiresIn=expiresIn
  --format=(text|json)       [default: text]

See code: src/commands/locations/create.ts

attic-cli locations:delete [QUERY]

deletes a location

USAGE
  $ attic-cli locations:delete [QUERY]

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help            show CLI help
  -i, --id=id
  -l, --limit=limit
  -o, --sort=sort
  -r, --href=href
  -s, --skip=skip
  -u, --auth=auth
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/locations/delete.ts

attic-cli locations:find [QUERY]

finds a location via MongoDB query

USAGE
  $ attic-cli locations:find [QUERY]

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help            show CLI help
  -i, --id=id
  -l, --limit=limit
  -o, --sort=sort
  -r, --href=href
  -s, --skip=skip
  -u, --auth=auth
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/locations/find.ts

attic-cli locations:search [TERMS]

searches for an entity via MongoDB text search

USAGE
  $ attic-cli locations:search [TERMS]

OPTIONS
  -c, --count
  -h, --help            show CLI help
  -l, --limit=limit
  -s, --skip=skip
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/locations/search.ts

attic-cli locations:update

updates an existing location, returning the url and id

USAGE
  $ attic-cli locations:update

OPTIONS
  -a, --hash=hash
  -d, --driver=driver
  -e, --entity=entity
  -h, --help                 show CLI help
  -i, --id=id                (required)
  -r, --href=href
  -s, --short
  -u, --auth=auth
  -v, --verbose
  -x, --expiresIn=expiresIn
  --format=(text|json)       [default: text]

See code: src/commands/locations/update.ts

attic-cli plugins

list installed plugins

USAGE
  $ attic-cli plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ attic-cli plugins

See code: @oclif/plugin-plugins

attic-cli plugins:inspect PLUGIN...

displays installation properties of a plugin

USAGE
  $ attic-cli plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] plugin to inspect

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

EXAMPLE
  $ attic-cli plugins:inspect myplugin

See code: @oclif/plugin-plugins

attic-cli plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ attic-cli 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
  $ attic-cli plugins:add

EXAMPLES
  $ attic-cli plugins:install myplugin 
  $ attic-cli plugins:install https://github.com/someuser/someplugin
  $ attic-cli plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

attic-cli plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ attic-cli 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
  $ attic-cli plugins:link myplugin

See code: @oclif/plugin-plugins

attic-cli plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ attic-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

ALIASES
  $ attic-cli plugins:unlink
  $ attic-cli plugins:remove

See code: @oclif/plugin-plugins

attic-cli plugins:update

update installed plugins

USAGE
  $ attic-cli plugins:update

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

See code: @oclif/plugin-plugins

attic-cli resolve:entity [ENTITY]

resolves a location to an entity

USAGE
  $ attic-cli resolve:entity [ENTITY]

OPTIONS
  -C, --noCache
  -h, --help            show CLI help
  -i, --id=id
  -r, --href=href
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/resolve/entity.ts

attic-cli resolve:location [LOCATION]

resolves a location to a location

USAGE
  $ attic-cli resolve:location [LOCATION]

OPTIONS
  -C, --noCache
  -h, --help            show CLI help
  -i, --id=id
  -r, --href=href
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/resolve/location.ts

attic-cli resolvers:create [FIELDS]

creates a resolver returning a resolver id

USAGE
  $ attic-cli resolvers:create [FIELDS]

OPTIONS
  -h, --help                   show CLI help
  -m, --mountPoint=mountPoint  (required)
  -p, --priority=priority
  -t, --type=type              (required)
  -v, --verbose
  --format=(text|json)         [default: text]

See code: src/commands/resolvers/create.ts

attic-cli resolvers:delete [QUERY]

deletes a resolver

USAGE
  $ attic-cli resolvers:delete [QUERY]

OPTIONS
  -e, --type=type
  -h, --help                   show CLI help
  -i, --id=id                  (required)
  -l, --limit=limit
  -m, --mountPoint=mountPoint
  -o, --sort=sort
  -s, --skip=skip
  -u, --priority=priority
  -v, --verbose
  --format=(text|json)         [default: text]

See code: src/commands/resolvers/delete.ts

attic-cli resolvers:find [QUERY]

finds an entity via MongoDB query

USAGE
  $ attic-cli resolvers:find [QUERY]

OPTIONS
  -h, --help                   show CLI help
  -i, --id=id
  -l, --limit=limit
  -m, --mountPoint=mountPoint
  -o, --sort=sort
  -p, --priority=priority
  -s, --skip=skip
  -t, --type=type
  -v, --verbose
  --format=(text|json)         [default: text]

See code: src/commands/resolvers/find.ts

attic-cli resolvers:listTypes

lists all resolver types

USAGE
  $ attic-cli resolvers:listTypes

OPTIONS
  -h, --help            show CLI help
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/resolvers/listTypes.ts

attic-cli resolvers:search [TERMS]

searches for a resolver via MongoDB text search

USAGE
  $ attic-cli resolvers:search [TERMS]

OPTIONS
  -c, --count
  -h, --help            show CLI help
  -l, --limit=limit
  -s, --skip=skip
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/resolvers/search.ts

attic-cli resolvers:update

updates an existing resolver

USAGE
  $ attic-cli resolvers:update

OPTIONS
  -e, --type=type
  -h, --help                   show CLI help
  -i, --id=id                  (required)
  -m, --mountPoint=mountPoint
  -u, --priority=priority
  -v, --verbose
  --format=(text|json)         [default: text]

See code: src/commands/resolvers/update.ts

attic-cli rpc

describe the command here

USAGE
  $ attic-cli rpc

OPTIONS
  -h, --help            show CLI help
  -m, --method=method   (required)
  -p, --params=params
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/rpc.ts

attic-cli shortUrl

shortens an existing URI, returning the new short url

USAGE
  $ attic-cli shortUrl

OPTIONS
  -G, --dontGenerate
  -d, --driver=driver        (required) [default: HTTPRedirectDriver]
  -h, --help                 show CLI help
  -n, --length=length
  -r, --href=href            (required)
  -s, --source=source        (required)
  -u, --auth=auth
  -v, --verbose
  -x, --expiresIn=expiresIn
  --format=(text|json)       [default: text]
  --quiet

See code: @znetstar/attic-cli-url-shortener

attic-cli users:create [FIELDS]

creates a user returning a user id

USAGE
  $ attic-cli users:create [FIELDS]

OPTIONS
  -d, --disabled
  -h, --help               show CLI help
  -p, --password=password
  -t, --type=type          (required)
  -u, --username=username
  -v, --verbose
  --format=(text|json)     [default: text]

See code: src/commands/users/create.ts

attic-cli users:delete [QUERY]

deletes a user

USAGE
  $ attic-cli users:delete [QUERY]

OPTIONS
  -d, --disabled
  -h, --help            show CLI help
  -i, --id=id
  -l, --limit=limit
  -o, --sort=sort
  -s, --skip=skip
  -t, --type=type
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/users/delete.ts

attic-cli users:find [QUERY]

finds a user via MongoDB query

USAGE
  $ attic-cli users:find [QUERY]

OPTIONS
  -d, --disabled
  -h, --help            show CLI help
  -i, --id=id
  -l, --limit=limit
  -o, --sort=sort
  -s, --skip=skip
  -t, --type=type
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/users/find.ts

attic-cli users:search [TERMS]

searches for users via MongoDB text search

USAGE
  $ attic-cli users:search [TERMS]

OPTIONS
  -c, --count
  -h, --help            show CLI help
  -l, --limit=limit
  -s, --skip=skip
  -v, --verbose
  --format=(text|json)  [default: text]

See code: src/commands/users/search.ts

attic-cli users:update

updates an existing location

USAGE
  $ attic-cli users:update

OPTIONS
  -d, --disabled
  -h, --help               show CLI help
  -i, --id=id              (required)
  -p, --password=password  (required)
  -u, --username=username
  -v, --verbose
  --format=(text|json)     [default: text]

See code: src/commands/users/update.ts