Skip to content

Commit

Permalink
Fix documentation to reflect CLI usage for collections-path (ansible#…
Browse files Browse the repository at this point in the history
  • Loading branch information
geerlingguy authored and samccann committed Sep 3, 2019
1 parent 9be8a98 commit f1180f3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/docsite/rst/dev_guide/collections_tech_preview.rst
Expand Up @@ -322,20 +322,20 @@ See the `content_collector README <https://github.com/ansible/content_collector>
Installing collections
======================

You can use the ``ansible-galaxy collection install`` command to install a collection on your system. The collection by default is installed at ``/path/ansible_collections/my_namespace/my_collection``. You can optionally add the ``-p`` option to specify an alternate location.
You can use the ``ansible-galaxy collection install`` command to install a collection on your system. You must specify an installation location using the ``-p`` option.

To install a collection hosted in Galaxy:

.. code-block:: bash
ansible-galaxy collection install my_namespace.my_collection -p /path
ansible-galaxy collection install my_namespace.my_collection -p /collections
You can also directly use the tarball from your build:

.. code-block:: bash
ansible-galaxy collection install my_namespace-my_collection-1.0.0.tar.gz -p ./collections/ansible_collections
ansible-galaxy collection install my_namespace-my_collection-1.0.0.tar.gz -p ./collections
.. note::
The install command automatically appends the path ``ansible_collections`` to the one specified with the ``-p`` option unless the
Expand Down

0 comments on commit f1180f3

Please sign in to comment.