@govuk-pay/cli

pay-cli

GOV.UK Pay Command Line Interface

Usage

This is published to NPM, you can install it globally using npm install -g @govuk-pay/cli, once it's installed you can run it using pay [arguments] or payx [arguments]. If you'd rather not install it globally you can run it using npx @govuk-pay/cli.

We're in the process of porting the existing Ruby CLI into typescript, we've tried to make that process transparent to the users of the CLI. Most of the commands rely on the existing ruby implementation therefore you'll need rbenv installed with bundler installed into it. When handing over to ruby we use zsh by default, if you want a different shell or rbenv you can set the following environment variables:

• PAY_CLI_RBENV_COMMAND - defaults to rbenv
• PAY_CLI_SHELL_COMMAND - defaults to zsh

To see the commands run pay without any arguments.

If you find that the ported typescript version isn't behaving as expected and you want to use the ruby version you can use the command legacy, for example:

• pay browse manual - uses the typescript port to open the team manual
• pay legacy browse manual - uses the original ruby version to open the team manual

Please add an issue any time you need to fall back on legacy behaviour so we can improve the typescript implementation.

Vulnerability Disclosure

GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. Please refer to our vulnerability disclosure policy and our security.txt file for details.