Skip to content

Commit fb858d9

Browse files
author
Matthew Fisher
committed
docs(customizing_deis): add "CLI Plugins" article
1 parent ec1f8f6 commit fb858d9

2 files changed

Lines changed: 37 additions & 0 deletions

File tree

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
:title: CLI Plugins
2+
:description: How to manage plugins for the Deis CLI.
3+
4+
.. _cli_plugins:
5+
6+
CLI Plugins
7+
===========
8+
9+
Plugins allow developers to extend the functionality of the :ref:`Deis Client <install-client>`,
10+
adding new commands or features.
11+
12+
If an unknown command is specified, the Client will attempt to execute the command as a
13+
dash-separated command. In this case, ``deis resource:command`` will execute ``deis-resource`` with
14+
the argument list ``command``. In full form:
15+
16+
.. code-block:: console
17+
18+
$ # these two are identical
19+
$ deis accounts:list
20+
$ deis-accounts list
21+
22+
Any flags after the command will also be sent to the plugin as an argument:
23+
24+
.. code-block:: console
25+
26+
$ # these two are identical
27+
$ deis accounts:list --debug
28+
$ deis-accounts list --debug
29+
30+
But flags preceeding the command will not:
31+
32+
.. code-block:: console
33+
34+
$ # these two are identical
35+
$ deis --debug accounts:list
36+
$ deis-accounts list

docs/customizing_deis/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Customizing Deis
1111

1212
.. toctree::
1313

14+
cli-plugins
1415
builder_settings
1516
cache_settings
1617
controller_settings

0 commit comments

Comments
 (0)