julesbonnard / apicore-cli

apicore CLI

• Usage
• Commands

Usage

$ npm install -g @julesbonnard/apicore-cli
$ apicore COMMAND
running command...
$ apicore (--version)
@julesbonnard/apicore-cli/0.2.0 darwin-arm64 node-v20.10.0
$ apicore --help [COMMAND]
USAGE
  $ apicore COMMAND
...

Commands

• apicore get ID
• apicore help [COMMAND]
• apicore login
• apicore notifications services
• apicore notifications services delete [SERVICENAME]
• apicore notifications subscriptions [SERVICENAME]
• apicore notifications subscriptions delete SERVICENAME SUBSCRIPTIONIDENTIFIER
• apicore search [QUERY]

apicore get ID

Get document using the API

USAGE
  $ apicore get ID [--json] [--profile <value>]

ARGUMENTS
  ID  UNO or shortId of the document to retrieve

FLAGS
  --profile=<value>  Define a custom profile to save auth config

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get document using the API

See code: src/commands/get/index.ts

apicore help [COMMAND]

Display help for apicore.

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

See code: @oclif/plugin-help

apicore login

Get a token for the API

USAGE
  $ apicore login [--json] [--profile <value>] [-a <value>] [-u <value>] [-i] [--username <value>]
    [--password <value>]

FLAGS
  -a, --apiKey=<value>    Your API Key
  -i, --info              Just check if you're authenticated
  -u, --baseUrl=<value>   [default: https://afp-apicore-prod.afp.com] The API base url
      --password=<value>  Your password (not recommended, prefer interactive prompt)
      --profile=<value>   Define a custom profile to save auth config
      --username=<value>  Your username (not recommended, prefer interactive prompt)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get a token for the API

EXAMPLES
  $ apicore login

  $ apicore login --info

  $ apicore login --json

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

apicore notifications services

List notifications services

USAGE
  $ apicore notifications services [--profile <value>]

FLAGS
  --profile=<value>  Define a custom profile to save auth config

DESCRIPTION
  List notifications services

See code: src/commands/notifications/services/index.ts

apicore notifications services delete [SERVICENAME]

Delete notifications service

USAGE
  $ apicore notifications services delete [SERVICENAME] [--profile <value>]

FLAGS
  --profile=<value>  Define a custom profile to save auth config

DESCRIPTION
  Delete notifications service

See code: src/commands/notifications/services/delete.ts

apicore notifications subscriptions [SERVICENAME]

List notifications subscriptions

USAGE
  $ apicore notifications subscriptions [SERVICENAME] [--profile <value>]

ARGUMENTS
  SERVICENAME  Name of the service to list subscriptions for

FLAGS
  --profile=<value>  Define a custom profile to save auth config

DESCRIPTION
  List notifications subscriptions

See code: src/commands/notifications/subscriptions/index.ts

apicore notifications subscriptions delete SERVICENAME SUBSCRIPTIONIDENTIFIER

Delete notifications subscription

USAGE
  $ apicore notifications subscriptions delete SERVICENAME SUBSCRIPTIONIDENTIFIER [--profile <value>]

ARGUMENTS
  SERVICENAME             Name of the service to delete the subscription from
  SUBSCRIPTIONIDENTIFIER  Identifier of the subscription to delete

FLAGS
  --profile=<value>  Define a custom profile to save auth config

DESCRIPTION
  Delete notifications subscription

See code: src/commands/notifications/subscriptions/delete.ts

apicore search [QUERY]

Search documents using the API

USAGE
  $ apicore search [QUERY] [--json] [--profile <value>] [-f <value>] [--from <value>] [-l <value>] [-p
    <value>] [--size <value>] [--sortField <value>] [--sortOrder asc|desc] [--table] [--to <value>] [--columns <value> |
    -x] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |  | ]

ARGUMENTS
  QUERY  Search query

FLAGS
  -f, --fields=<value>...    [default: afpshortid,uno,revision,country,product,created,published,lang,headline,slug]
                             Fields to return
  -l, --langs=<value>...     Langs separated by commas, like fr,es
  -p, --products=<value>...  Products separated by commas, like news,photo
  -x, --extended             show extra columns
      --columns=<value>      only show provided columns (comma-separated)
      --csv                  output is csv format [alias: --output=csv]
      --from=<value>         [default: 2012-01-01] From date
      --no-header            hide table header from output
      --no-truncate          do not truncate output to fit screen
      --output=<option>      output in a more machine friendly format
                             <options: csv|json|yaml>
      --profile=<value>      Define a custom profile to save auth config
      --size=<value>         [default: 10] Max number of documents to return
      --sortField=<value>    [default: published] Sort field
      --sortOrder=<option>   [default: desc] Sort order
                             <options: asc|desc>
      --table                Print the results as a table
      --to=<value>           [default: now] To date

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Search documents using the API

EXAMPLES
  $ apicore search

  $ apicore search "france" -l fr,es

  $ apicore search --json

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