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.

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

Show default values in CLI #661

Merged
merged 1 commit into from
Sep 3, 2024
Merged

Show default values in CLI #661

merged 1 commit into from
Sep 3, 2024

Conversation

maresb
Copy link
Contributor

@maresb maresb commented Aug 29, 2024

Closes #658

$ conda-lock lock --help
Usage: conda-lock lock [OPTIONS]

  Generate fully reproducible lock files for conda environments.

  By default, a multi-platform lock file is written to conda-lock.yml.

  When choosing the "explicit" or "env" kind, lock files are written to
  conda-{platform}.lock. These filenames can be customized using the
  --filename-template argument. The following tokens are available:

      platform: The platform this lock file was generated for (conda subdir).
      dev-dependencies: Whether or not dev dependencies are included in this lock file.
      input-hash: A sha256 hash of the lock file input specification.
      version: The version of conda-lock used to generate this lock file.
      timestamp: The approximate timestamp of the output file in ISO8601 basic format.

Options:
  --conda TEXT                    path (or name) of the conda/mamba executable
                                  to use.
  --mamba / --no-mamba            don't attempt to use or install mamba.
                                  [default: mamba]
  --micromamba / --no-micromamba  don't attempt to use or install micromamba.
                                  [default: no-micromamba]
  -p, --platform TEXT             generate lock files for the following
                                  platforms
  -c, --channel TEXT              Override the channels to use when solving
                                  the environment. These will replace the
                                  channels as listed in the various source
                                  files.
  --dev-dependencies / --no-dev-dependencies
                                  include dev dependencies in the lockfile
                                  (where applicable)  [default: dev-
                                  dependencies]
  -f, --file PATH                 path to a conda environment specification(s)
                                  [default: environment.yml]
  -k, --kind TEXT                 Kind of lock file(s) to generate [should be
                                  one of 'lock', 'explicit', or 'env'].
                                  [default: lock]
  --filename-template TEXT        Template for single-platform (explicit, env)
                                  lock file names. Filename must include
                                  {platform} token, and must not end in
                                  '.yml'. For a full list and description of
                                  available tokens, see the command help text.
                                  [default: conda-{platform}.lock]
  --lockfile TEXT                 Path to a conda-lock.yml to create or update
                                  [default: conda-lock.yml]
  --strip-auth                    Strip the basic auth credentials from the
                                  lockfile.
  -e, --extras, --category TEXT   When used in conjunction with input sources
                                  that support extras/categories
                                  (pyproject.toml) will add the deps from
                                  those extras to the render specification
  --filter-categories, --filter-extras
                                  In conjunction with extras this will prune
                                  out dependencies that do not have the extras
                                  specified when loading files.
  --check-input-hash              Check existing input hashes in lockfiles
                                  before regenerating lock files.  If no files
                                  were updated exit with exit code 4.
                                  Incompatible with --strip-auth
  --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                  Log level.  [default: INFO]
  --pdb                           Drop into a postmortem debugger if conda-
                                  lock crashes
  --virtual-package-spec PATH     Specify a set of virtual packages to use.
  --update TEXT                   Packages to update to their latest versions.
                                  If empty, update all.
  --pypi_to_conda_lookup_file TEXT
                                  Location of the lookup file containing Pypi
                                  package names to conda names.
  --md, --metadata [timestamp|git_sha|git_user_name|git_user_email|input_md5|input_sha]
                                  Metadata fields to include in lock-file
  --with-cuda TEXT                Specify cuda version to use in virtual
                                  packages. Avoids warning about implicit
                                  acceptance of cuda dependencies. Ignored if
                                  virtual packages are specified.
  --without-cuda                  Disable cuda in virtual packages. Prevents
                                  accepting cuda variants of packages. Ignored
                                  if virtual packages are specified.
  --mdy, --metadata-yaml, --metadata-json PATH
                                  YAML or JSON file(s) containing structured
                                  metadata to add to metadata section of the
                                  lockfile.
  --help                          Show this message and exit.

@maresb maresb requested a review from a team as a code owner August 29, 2024 09:20
Copy link

netlify bot commented Aug 29, 2024

Deploy Preview for conda-lock ready!

Name Link
🔨 Latest commit 7ef40ee
🔍 Latest deploy log https://app.netlify.com/sites/conda-lock/deploys/66d03d5170f95800085983c5
😎 Deploy Preview https://deploy-preview-661--conda-lock.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@maresb maresb merged commit b51118d into conda:main Sep 3, 2024
10 checks passed
@maresb maresb deleted the show-cli-defaults branch September 3, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can’t tell if CLI will use mamba
1 participant