Skip to content

Commit

Permalink
docs: Clarify installation of lock file (#3686)
Browse files Browse the repository at this point in the history
Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
  • Loading branch information
jjerphan authored Dec 11, 2024
1 parent 99290ae commit dd5abc3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,12 @@ See the [repoquery documentation](https://mamba.readthedocs.io/en/latest/user_gu

`micromamba` can be used to install lock files generated by [conda-lock](https://conda.github.io/conda-lock/) without having to install `conda-lock`.

Simply invoke e.g. `micromamba create -n my-env -f conda-lock.yml` with an environment lockfile named `*-lock.yml` or `*-lock.yaml`.
Simply invoke `micromamba create` with the `-f` option, providing an environment lockfile whose name ends with
`-lock.yml` or `-lock.yaml`; for instance:

```bash
micromamba create -n my-env -f conda-lock.yml
```

### setup-micromamba (setup-miniconda replacement)

Expand Down
2 changes: 2 additions & 0 deletions docs/source/user_guide/micromamba.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,8 @@ These files are named ``conda-lock.yml`` by default, and look like:
category: main
optional: false
In order to YAML files to be considered as ``conda-lock`` files, their name must ends with ``-lock.yml`` or ``-lock.yaml``.

To install such a file with ``micromamba``, just pass the ``-f`` flag again:

.. code::
Expand Down

0 comments on commit dd5abc3

Please sign in to comment.