Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.18 KB

file.rst

File metadata and controls

46 lines (31 loc) · 1.18 KB
Raw

Config file

Nextstrain CLI uses an INI-style configuration file to store information about the runtimes that are set up. For example:

[core]
runner = docker

[docker]
image = nextstrain/base:build-20230623T174208Z

The default configuration file is ~/.nextstrain/config. This path may be overridden entirely by the NEXTSTRAIN_CONFIG environment variable. Alternatively, the path of the containing directory (i.e. ~/.nextstrain/) may be overridden by the NEXTSTRAIN_HOME environment variable.

Sections

  • Core variables
  • Docker runtime variables <docker-config>
  • Singularity runtime variables <singularity-config>
  • AWS Batch runtime variables <aws-batch-config>

Core variables

core.runner <configuration variable; core.runner>

Short name of the default runtime. Typically set by running one of:

nextstrain setup --set-default <runtime>
nextstrain check-setup --set-default

If not set, the /runtimes/docker (docker) is used.