govuk-notify-cli v0.4.0

govuk-notify-cli

• govuk-notify-cli
• Usage
• Commands

Usage

$ npm install -g govuk-notify-cli
$ notifycli COMMAND
running command...
$ notifycli (--version)
govuk-notify-cli/0.4.0 darwin-arm64 node-v21.7.1
$ notifycli --help [COMMAND]
USAGE
  $ notifycli COMMAND
...

Commands

• notifycli help [COMMAND]
• notifycli list SERVICENAME
• notifycli pdf SERVICENAME NOTIFICATIONID
• notifycli service
• notifycli service add SERVICENAME APIKEY
• notifycli service remove SERVICENAME
• notifycli status SERVICENAME NOTIFICATIONID

notifycli help [COMMAND]

Display help for notifycli.

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

See code: @oclif/plugin-help

notifycli list SERVICENAME

List recent notifcations for a Notify service

USAGE
  $ notifycli list SERVICENAME [-t email|sms|letter] [-r <value>] [-j]

ARGUMENTS
  SERVICENAME  The name of the Notify service

FLAGS
  -j, --json               Output API JSON body instead of table of results
  -r, --reference=<value>  Filter notifications by reference
  -t, --type=<option>      Filter notifications by type
                           <options: email|sms|letter>

DESCRIPTION
  List recent notifcations for a Notify service

EXAMPLES
  $ notifycli list serviceName

See code: src/commands/list/index.js

notifycli pdf SERVICENAME NOTIFICATIONID

Get PDF for a letter notifcation

USAGE
  $ notifycli pdf SERVICENAME NOTIFICATIONID [-f <value>]

ARGUMENTS
  SERVICENAME     The name of the Notify service
  NOTIFICATIONID  The ID of the notification

FLAGS
  -f, --file=<value>  Set the output filename, default: $notificationId.pdf

DESCRIPTION
  Get PDF for a letter notifcation

EXAMPLES
  $ notifycli pdf pdf serviceName notificationId

See code: src/commands/pdf/index.js

notifycli service

List, add and remove Notify services

USAGE
  $ notifycli service [-v]

FLAGS
  -v, --verbose  Show service names and API keys

DESCRIPTION
  List, add and remove Notify services

EXAMPLES
  List configured Notify services:

  $ notifycli service
  myservice

  $ notifycli service -v
  myservice api-key

See code: src/commands/service/index.js

notifycli service add SERVICENAME APIKEY

Add a Notify service

USAGE
  $ notifycli service add SERVICENAME APIKEY

ARGUMENTS
  SERVICENAME  What to call the Notify service
  APIKEY       The API key of the Notify service

DESCRIPTION
  Add a Notify service

EXAMPLES
  $ notifycli service add myServiceName myApiKey

See code: src/commands/service/add.js

notifycli service remove SERVICENAME

Remove a Notify service

USAGE
  $ notifycli service remove SERVICENAME

ARGUMENTS
  SERVICENAME  The name of the Notify service to remove

DESCRIPTION
  Remove a Notify service

EXAMPLES
  $ notifycli service remove myServiceName

See code: src/commands/service/remove.js

notifycli status SERVICENAME NOTIFICATIONID

Get the status of a notification

USAGE
  $ notifycli status SERVICENAME NOTIFICATIONID [-j]

ARGUMENTS
  SERVICENAME     The name of the Notify service
  NOTIFICATIONID  The ID of the notification

FLAGS
  -j, --json  Output API JSON body instead of table of data

DESCRIPTION
  Get the status of a notification

EXAMPLES
  $ notifycli status status serviceName notificationId

See code: src/commands/status/index.js