diff options
| author | Ramakrishnan G <rameshg87@gmail.com> | 2014-06-22 23:31:50 +0530 |
|---|---|---|
| committer | Ramakrishnan G <rameshg87@gmail.com> | 2014-07-09 22:50:12 +0530 |
| commit | 1155530941ddeb1b948939fa400ba722ed5ccd0f (patch) | |
| tree | 0b2d6300c0984fb6c907e856d6185d779cd6fadc /doc | |
| parent | 2ea6e1026a357161e81306884f00d4f0cb79b469 (diff) | |
| download | python-ironicclient-1155530941ddeb1b948939fa400ba722ed5ccd0f.tar.gz | |
Add bash completion support for ironic cli
This commit adds the 'bash-completion' option to
ironic cli which prints all sub-commands and
options, and bash_completion scripts for bash
auto completion.
Change-Id: Ide5b29e262b4217046f124d86902cd0abfdab1b6
Closes-Bug: 1332408
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/cli.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/cli.rst b/doc/source/cli.rst index 40b3537..b0a7ee6 100644 --- a/doc/source/cli.rst +++ b/doc/source/cli.rst @@ -42,6 +42,16 @@ supplying an auth token using :option:`--ironic-url` and export IRONIC_URL=http://ironic.example.org:6385/ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155 +Ironic cli supports bash completion. The command-line tool can automatically +fill partially typed commands. To use this feature, source the below file to +your terminal and then bash completion should work:: + + source tools/ironic.bash_completion + +To avoid doing this everytime, add this to your ``.bashrc`` or copy the +ironic.bash_completion file to the default bash completion scripts directory +on your linux distribution. + OPTIONS ======= |