Skip to main content

jnc init

Creates a new workspace. This command generates a manifest file (pixi.toml by default) and supporting files to get you started with dependency management and task running. The manifest format can be customized with --format to generate a pyproject.toml instead. You can also bootstrap a workspace from an existing conda environment.yml file.

Usage

jnc init [OPTIONS] [PATH]

Arguments

ArgumentDescription
PATHWhere to place the workspace. Defaults to the current directory (.).

Options

OptionDescription
-c, --channel <CHANNEL>Channel to use in the workspace. Can be specified multiple times. Conflicts with --import.
-p, --platform <PLATFORM>Platforms that the workspace supports. Can be specified multiple times.
-i, --import <ENVIRONMENT_FILE>Path to a conda environment.yml file to bootstrap the workspace from.
--format <FORMAT>The manifest format to create. Values: pixi, pyproject. Conflicts with --import.
-s, --scm <SCM>Source control management provider. Generates appropriate .gitignore and .gitattributes files. Values: github, gitlab, codeberg.
--conda-pypi-map <MAPPING>Mapping between conda channels and PyPI indexes, as comma-separated CHANNEL=URL pairs.

Examples

Create a workspace in the current directory

jnc init

Create a workspace in a new directory

jnc init my-project

Create a workspace with specific channels

jnc init --channel conda-forge --channel bioconda

Create a workspace for specific platforms

jnc init --platform linux-aarch64

Create a pyproject.toml-based workspace

jnc init --format pyproject

Bootstrap from an existing environment.yml

jnc init --import environment.yml

Create a workspace with GitHub SCM files

jnc init --scm github my-project