Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Adapt shell completion subsection #3672

Merged
merged 1 commit into from
Dec 9, 2024
Merged

docs: Adapt shell completion subsection #3672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions docs/source/installation/micromamba-installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,30 +230,3 @@ The executable can be striped to remove its size:
.. code:: bash

strip "build/micromamba/micromamba"


.. _shell_completion:

Shell completion
****************

For now, only ``micromamba`` provides shell completion on ``bash`` and ``zsh``.

To activate it, it's as simple as running:

.. code:: bash

micromamba shell completion

The completion is now available in any new shell opened or in the current shell after sourcing the configuration file to take modifications into account.

.. code-block:: sh

source ~/.<shell>rc

| Just hit ``<TAB><TAB>`` to get completion when typing your command.
| For example the following command will help you to pick a named environment to activate:

.. code-block:: bash

micromamba activate <TAB><TAB>
15 changes: 15 additions & 0 deletions docs/source/user_guide/concepts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,18 @@ Deactivation
************

The *deactivation* is the opposite operation of :ref:`activation<activation>`, removing from your shell what makes the environment content accessible.


.. _shell_completion:

Shell completion
****************

After initialization, shell completion is available in any new shell.
Just hit ``<TAB><TAB>`` to get completion when typing your command.

For example the following command will help you to pick a named environment to activate:

.. code-block:: bash

micromamba activate <TAB><TAB>
Loading