@govuk-pay/cli 0.0.51 → 0.0.52

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@govuk-pay/cli",
3
- "version": "0.0.51",
3
+ "version": "0.0.52",
4
4
  "description": "GOV.UK Pay Command Line Interface",
5
5
  "bin": {
6
6
  "pay": "bin/cli.js",
package/readme.md CHANGED
@@ -40,6 +40,17 @@ use the command `legacy`, for example:
40
40
 
41
41
  Please add an issue any time you need to fall back on legacy behaviour so we can improve the typescript implementation.
42
42
 
43
+ ### Shell auto completion
44
+
45
+ If you want to enable tab completion of commands and parameters then you can run
46
+
47
+ ```
48
+ pay completion
49
+ ```
50
+
51
+ This will generate a script (for bash or zsh only) which you can put at the end of your .bashrc or .zshrc that will cause your
52
+ shell to provide auto completions.
53
+
43
54
  ### Config files
44
55
 
45
56
  Config files needed by the pay cli will go in `$HOME/.pay-cli"
@@ -18,6 +18,7 @@ async function runCommand() {
18
18
  .strict()
19
19
  .help()
20
20
  .wrap(yargsInstance.terminalWidth())
21
+ .completion('completion', 'Generate shell (bash/zsh only) auto-completion script. Put the script at the end of your .bashrc or .zshrc')
21
22
  .parse();
22
23
  }
23
24
  exports.default = runCommand;