Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/partial-pixi-json/latest.json
Source https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/partial-pixi.json

Validate with Lintel

npx @lintel/lintel check
Type: object

The [tool.pixi] section of a pyproject.toml.

Properties

activation object

A description of steps performed when an environment is activated

2 nested properties
env Record<string, string>

A map of environment variables to values, used in the activation of the environment. These will be set in the shell. Thus these variables are shell specific. Using '$' might not expand to a value in different shells.

Examples: {"key":"value"}, {"ARGUMENT":"value"}
scripts string[]

The scripts to run when the environment is activated

Examples: "activate.sh", "activate.bat"
build-dependencies Record<string, string | MatchspecTable>

The build conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

constraints Record<string, string | MatchspecTable>

The conda version constraints. These constrain the versions of packages that may be installed without explicitly requiring them. If the package is installed as a dependency of another package, it must satisfy these constraints.

dependencies Record<string, string | MatchspecTable>

The conda dependencies, consisting of a package name and a requirement in MatchSpec format

dev Record<string, object>

Source packages whose dependencies should be installed without building the package itself. Useful for development environments.

environments object

The environments of the project, defined as a full object or a list of feature names.

feature Record<string, object>

The features of the project

host-dependencies Record<string, string | MatchspecTable>

The host conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

Examples: {"python":">=3.8"}
package object

The package's metadata information.

15 nested properties
build object required
6 nested properties
backend object required
19 nested properties
additional-dependencies Record<string, string | MatchspecTable>

Additional dependencies to install alongside the build backend

branch string

A git branch to use

minLength=1
build string

The build string of the package

minLength=1
build-number string

The build number of the package, can be a spec like >=1 or <=10 or 1

minLength=1
channel string

The channel the packages needs to be fetched from

Examples: "conda-forge", "pytorch", "https://prefix.dev/conda-forge"
minLength=1
channels string | string | ChannelInlineTable[]

The conda channels that are used to fetch the build backend from

file-name string

The file name of the package

minLength=1
git string

The git URL to the repo

minLength=1
license string

The license of the package

minLength=1
md5 string

The md5 hash of the package

pattern=^[a-fA-F0-9]{32}$
name string

The name of the build backend package

minLength=1
path string

The path to the package

minLength=1
rev string

A git SHA revision to use

minLength=1
sha256 string

The sha256 hash of the package

pattern=^[a-fA-F0-9]{64}$
subdir string

The subdir of the package, also known as platform

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
url string

The URL to the package

minLength=1
version string

The version of the package in MatchSpec format

minLength=1
additional-dependencies Record<string, string | MatchspecTable>

Additional dependencies to install alongside the build backend

channels string | string | ChannelInlineTable[]

The conda channels that are used to fetch the build backend from

config object

The configuration of the build backend

source object

The location of a package's source code.

6 nested properties
branch string

A git branch to use

minLength=1
git string

The git URL to the source repo

minLength=1
path string

The path to the source

minLength=1
rev string

A git SHA revision to use

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
target Record<string, object>

Target-specific build configuration for different platforms

Examples: {"linux-64":{"config":{"key":"value"}}}
authors string[] | WorkspaceInheritance

The authors of the project. Can be a list of strings or { workspace = true } to inherit from workspace

Examples: ["John Doe <[email protected]>"], {"workspace":true}
build-dependencies Record<string, string | MatchspecTable>

The build conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

description string | WorkspaceInheritance

A short description of the project. Can be a string or { workspace = true } to inherit from workspace

documentation string | WorkspaceInheritance

The URL of the documentation of the project. Can be a URL or { workspace = true } to inherit from workspace

homepage string | WorkspaceInheritance

The URL of the homepage of the project. Can be a URL or { workspace = true } to inherit from workspace

host-dependencies Record<string, string | MatchspecTable>

The host conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

Examples: {"python":">=3.8"}
license string | WorkspaceInheritance

The license of the project; we advise using an SPDX identifier. Can be a string or { workspace = true } to inherit from workspace

license-file string | WorkspaceInheritance

The path to the license file of the project. Can be a path or { workspace = true } to inherit from workspace

name string | WorkspaceInheritance

The name of the package. Can be a string or { workspace = true } to inherit from workspace

readme string | WorkspaceInheritance

The path to the readme file of the project. Can be a path or { workspace = true } to inherit from workspace

repository string | WorkspaceInheritance

The URL of the repository of the project. Can be a URL or { workspace = true } to inherit from workspace

run-dependencies Record<string, string | MatchspecTable>

The conda dependencies required at runtime. See https://pixi.sh/latest/build/dependency_types/ for more information.

target Record<string, object>

Machine-specific aspects of the package

Examples: {"linux":{"host-dependencies":{"python":"3.8"}}}
version string | WorkspaceInheritance

The version of the project; we advise use of SemVer. Can be a string or { workspace = true } to inherit from workspace

Examples: "1.2.3", {"workspace":true}
project object

The project's metadata information.

23 nested properties
channels string | string | ChannelInlineTable[] required

The conda channels that can be used in the project. Unless overridden by priority, the first channel listed will be preferred.

authors string[]

The authors of the project

Examples: "John Doe <[email protected]>"
build-variants Record<string, string[]>

The build variants of the project

build-variants-files string[]

Ordered list of variant definition files.

channel-priority string

The priority of the channel.

Values: "disabled" "strict"
conda-pypi-map Record<string, string | string>

The conda to PyPI mapping configuration

description string

A short description of the project

minLength=1
documentation string

The URL of the documentation of the project

format=uriminLength=1
exclude-newer string

Exclude any package newer than this date

Examples: "2023-11-03", "2023-11-03T03:33:12Z"
pattern=^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2}))?$
homepage string

The URL of the homepage of the project

format=uriminLength=1
license string

The license of the project; we advise using an SPDX identifier.

minLength=1
license-file string

The path to the license file of the project

pattern=^[^\\]+$
name string

The name of the project; we advise use of the name of the repository

minLength=1
platforms Platform[]

The platforms that the project supports

preview string | string[] | boolean

Defines the enabling of preview features of the project

pypi-options object

Options that determine the behavior of PyPI package resolution and installation

10 nested properties
dependency-overrides Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

A list of PyPI dependencies that override the resolved dependencies

Examples: {"numpy":">=1.21.0"}
extra-index-urls string[]

Additional PyPI registries that should be used as extra indexes

Examples: ["https://pypi.org/simple"]
find-links FindLinksPath | FindLinksURL[]

Paths to directory containing

Examples: ["https://pypi.org/simple"]
index-strategy string | string | string

The strategy to use when resolving packages from multiple indexes

Examples: "first-index", "unsafe-first-match", "unsafe-best-match"
index-url string

PyPI registry that should be used as the primary index

Examples: "https://pypi.org/simple"
minLength=1
no-binary boolean | string[]

Don't use pre-built wheels for these packages

Examples: "true", "false"
no-build boolean | string[]

Packages that should NOT be built

Examples: "true", "false"
no-build-isolation boolean | string[]

Packages that should NOT be isolated during the build process

Examples: ["numpy"], true
prerelease-mode string | string | string | string | string

The strategy to use when considering pre-release versions

Examples: "disallow", "allow", "if-necessary", "explicit", "if-necessary-or-explicit"
skip-wheel-filename-check boolean

Skip wheel filename validation, allowing installation of wheels with version mismatches between filename and metadata

Examples: true, false
readme string

The path to the readme file of the project

pattern=^[^\\]+$
repository string

The URL of the repository of the project

format=uriminLength=1
requires-pixi string

The required version spec for pixi itself to resolve and build the project.

Examples: ">=0.40"
minLength=1
s3-options Record<string, object>

Options related to S3 for this project

solve-strategy string

The strategy used to solve packages.

Values: "highest" "lowest" "lowest-direct"
target Record<string, object>

The workspace targets

version string

The version of the project; we advise use of SemVer

Examples: "1.2.3"
minLength=1
pypi-dependencies Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

The PyPI dependencies

pypi-options object

Options that determine the behavior of PyPI package resolution and installation

10 nested properties
dependency-overrides Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

A list of PyPI dependencies that override the resolved dependencies

Examples: {"numpy":">=1.21.0"}
extra-index-urls string[]

Additional PyPI registries that should be used as extra indexes

Examples: ["https://pypi.org/simple"]
find-links FindLinksPath | FindLinksURL[]

Paths to directory containing

Examples: ["https://pypi.org/simple"]
index-strategy string | string | string

The strategy to use when resolving packages from multiple indexes

Examples: "first-index", "unsafe-first-match", "unsafe-best-match"
index-url string

PyPI registry that should be used as the primary index

Examples: "https://pypi.org/simple"
minLength=1
no-binary boolean | string[]

Don't use pre-built wheels for these packages

Examples: "true", "false"
no-build boolean | string[]

Packages that should NOT be built

Examples: "true", "false"
no-build-isolation boolean | string[]

Packages that should NOT be isolated during the build process

Examples: ["numpy"], true
prerelease-mode string | string | string | string | string

The strategy to use when considering pre-release versions

Examples: "disallow", "allow", "if-necessary", "explicit", "if-necessary-or-explicit"
skip-wheel-filename-check boolean

Skip wheel filename validation, allowing installation of wheels with version mismatches between filename and metadata

Examples: true, false
system-requirements object

Platform-specific requirements

6 nested properties
archspec string

The architecture the project supports

minLength=1
cuda number | string

The minimum version of CUDA

libc LibcFamily | number | string

The minimum version of libc

linux number | string

The minimum version of the Linux kernel

macos number | string

The minimum version of MacOS

unix boolean | string

Whether the project supports UNIX

Examples: "true"
target Record<string, object>

The targets of the project

Examples: {"linux":{"dependencies":{"python":"3.8"}}}
tasks object

The tasks of the project

tool object

Third-party tool configurations, ignored by pixi

workspace object

The project's metadata information.

23 nested properties
channels string | string | ChannelInlineTable[] required

The conda channels that can be used in the project. Unless overridden by priority, the first channel listed will be preferred.

authors string[]

The authors of the project

Examples: "John Doe <[email protected]>"
build-variants Record<string, string[]>

The build variants of the project

build-variants-files string[]

Ordered list of variant definition files.

channel-priority string

The priority of the channel.

Values: "disabled" "strict"
conda-pypi-map Record<string, string | string>

The conda to PyPI mapping configuration

description string

A short description of the project

minLength=1
documentation string

The URL of the documentation of the project

format=uriminLength=1
exclude-newer string

Exclude any package newer than this date

Examples: "2023-11-03", "2023-11-03T03:33:12Z"
pattern=^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2}))?$
homepage string

The URL of the homepage of the project

format=uriminLength=1
license string

The license of the project; we advise using an SPDX identifier.

minLength=1
license-file string

The path to the license file of the project

pattern=^[^\\]+$
name string

The name of the project; we advise use of the name of the repository

minLength=1
platforms Platform[]

The platforms that the project supports

preview string | string[] | boolean

Defines the enabling of preview features of the project

pypi-options object

Options that determine the behavior of PyPI package resolution and installation

10 nested properties
dependency-overrides Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

A list of PyPI dependencies that override the resolved dependencies

Examples: {"numpy":">=1.21.0"}
extra-index-urls string[]

Additional PyPI registries that should be used as extra indexes

Examples: ["https://pypi.org/simple"]
find-links FindLinksPath | FindLinksURL[]

Paths to directory containing

Examples: ["https://pypi.org/simple"]
index-strategy string | string | string

The strategy to use when resolving packages from multiple indexes

Examples: "first-index", "unsafe-first-match", "unsafe-best-match"
index-url string

PyPI registry that should be used as the primary index

Examples: "https://pypi.org/simple"
minLength=1
no-binary boolean | string[]

Don't use pre-built wheels for these packages

Examples: "true", "false"
no-build boolean | string[]

Packages that should NOT be built

Examples: "true", "false"
no-build-isolation boolean | string[]

Packages that should NOT be isolated during the build process

Examples: ["numpy"], true
prerelease-mode string | string | string | string | string

The strategy to use when considering pre-release versions

Examples: "disallow", "allow", "if-necessary", "explicit", "if-necessary-or-explicit"
skip-wheel-filename-check boolean

Skip wheel filename validation, allowing installation of wheels with version mismatches between filename and metadata

Examples: true, false
readme string

The path to the readme file of the project

pattern=^[^\\]+$
repository string

The URL of the repository of the project

format=uriminLength=1
requires-pixi string

The required version spec for pixi itself to resolve and build the project.

Examples: ">=0.40"
minLength=1
s3-options Record<string, object>

Options related to S3 for this project

solve-strategy string

The strategy used to solve packages.

Values: "highest" "lowest" "lowest-direct"
target Record<string, object>

The workspace targets

version string

The version of the project; we advise use of SemVer

Examples: "1.2.3"
minLength=1

Definitions

Activation object

A description of steps performed when an environment is activated

env Record<string, string>

A map of environment variables to values, used in the activation of the environment. These will be set in the shell. Thus these variables are shell specific. Using '$' might not expand to a value in different shells.

Examples: {"key":"value"}, {"ARGUMENT":"value"}
scripts string[]

The scripts to run when the environment is activated

Examples: "activate.sh", "activate.bat"
Build object
backend object required
19 nested properties
additional-dependencies Record<string, string | MatchspecTable>

Additional dependencies to install alongside the build backend

branch string

A git branch to use

minLength=1
build string

The build string of the package

minLength=1
build-number string

The build number of the package, can be a spec like >=1 or <=10 or 1

minLength=1
channel string

The channel the packages needs to be fetched from

Examples: "conda-forge", "pytorch", "https://prefix.dev/conda-forge"
minLength=1
channels string | string | ChannelInlineTable[]

The conda channels that are used to fetch the build backend from

file-name string

The file name of the package

minLength=1
git string

The git URL to the repo

minLength=1
license string

The license of the package

minLength=1
md5 string

The md5 hash of the package

pattern=^[a-fA-F0-9]{32}$
name string

The name of the build backend package

minLength=1
path string

The path to the package

minLength=1
rev string

A git SHA revision to use

minLength=1
sha256 string

The sha256 hash of the package

pattern=^[a-fA-F0-9]{64}$
subdir string

The subdir of the package, also known as platform

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
url string

The URL to the package

minLength=1
version string

The version of the package in MatchSpec format

minLength=1
additional-dependencies Record<string, string | MatchspecTable>

Additional dependencies to install alongside the build backend

channels string | string | ChannelInlineTable[]

The conda channels that are used to fetch the build backend from

config object

The configuration of the build backend

source object

The location of a package's source code.

6 nested properties
branch string

A git branch to use

minLength=1
git string

The git URL to the source repo

minLength=1
path string

The path to the source

minLength=1
rev string

A git SHA revision to use

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
target Record<string, object>

Target-specific build configuration for different platforms

Examples: {"linux-64":{"config":{"key":"value"}}}
BuildBackend object
additional-dependencies Record<string, string | MatchspecTable>

Additional dependencies to install alongside the build backend

branch string

A git branch to use

minLength=1
build string

The build string of the package

minLength=1
build-number string

The build number of the package, can be a spec like >=1 or <=10 or 1

minLength=1
channel string

The channel the packages needs to be fetched from

Examples: "conda-forge", "pytorch", "https://prefix.dev/conda-forge"
minLength=1
channels string | string | ChannelInlineTable[]

The conda channels that are used to fetch the build backend from

file-name string

The file name of the package

minLength=1
git string

The git URL to the repo

minLength=1
license string

The license of the package

minLength=1
md5 string

The md5 hash of the package

pattern=^[a-fA-F0-9]{32}$
name string

The name of the build backend package

minLength=1
path string

The path to the package

minLength=1
rev string

A git SHA revision to use

minLength=1
sha256 string

The sha256 hash of the package

pattern=^[a-fA-F0-9]{64}$
subdir string

The subdir of the package, also known as platform

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
url string

The URL to the package

minLength=1
version string

The version of the package in MatchSpec format

minLength=1
BuildTarget object

Target-specific build configuration for different platforms

config object

Target-specific configuration for the build backend

ChannelInlineTable object

A precise description of a conda channel, with an optional priority.

channel string | string required

The channel the packages needs to be fetched from

priority integer

The priority of the channel

ChannelPriority string

The priority of the channel.

DependsOn object

The dependencies of a task.

task string required

the name of the task to depend on

minLength=1pattern=^[^\s\$]+$
args string | object[]

The (positional or named) arguments to pass to the task

environment string

The environment to use for the task

pattern=^[a-z0-9\-]+$
Environment object

A composition of the dependencies of features which can be activated to run tasks or provide a shell

features string[]

The features that define the environment

no-default-feature boolean

Whether to add the default feature to this environment

Default: false
solve-group string

The group name for environments that should be solved together

minLength=1
Feature object

A composable aspect of the project which can contribute dependencies and tasks to an environment

activation object

A description of steps performed when an environment is activated

2 nested properties
env Record<string, string>

A map of environment variables to values, used in the activation of the environment. These will be set in the shell. Thus these variables are shell specific. Using '$' might not expand to a value in different shells.

Examples: {"key":"value"}, {"ARGUMENT":"value"}
scripts string[]

The scripts to run when the environment is activated

Examples: "activate.sh", "activate.bat"
build-dependencies Record<string, string | MatchspecTable>

The build conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

channel-priority string

The priority of the channel.

Values: "disabled" "strict"
channels string | string | ChannelInlineTable[]

The conda channels that can be considered when solving environments containing this feature

constraints Record<string, string | MatchspecTable>

The conda version constraints. These constrain the versions of packages that may be installed without explicitly requiring them. If the package is installed as a dependency of another package, it must satisfy these constraints.

dependencies Record<string, string | MatchspecTable>

The conda dependencies, consisting of a package name and a requirement in MatchSpec format

dev Record<string, object>

Source packages whose dependencies should be installed without building the package itself. Useful for development environments.

host-dependencies Record<string, string | MatchspecTable>

The host conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

Examples: {"python":">=3.8"}
platforms Platform[]

The platforms that the feature supports: a union of all features combined in one environment is used for the environment.

pypi-dependencies Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

The PyPI dependencies of this feature

pypi-options object

Options that determine the behavior of PyPI package resolution and installation

10 nested properties
dependency-overrides Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

A list of PyPI dependencies that override the resolved dependencies

Examples: {"numpy":">=1.21.0"}
extra-index-urls string[]

Additional PyPI registries that should be used as extra indexes

Examples: ["https://pypi.org/simple"]
find-links FindLinksPath | FindLinksURL[]

Paths to directory containing

Examples: ["https://pypi.org/simple"]
index-strategy string | string | string

The strategy to use when resolving packages from multiple indexes

Examples: "first-index", "unsafe-first-match", "unsafe-best-match"
index-url string

PyPI registry that should be used as the primary index

Examples: "https://pypi.org/simple"
minLength=1
no-binary boolean | string[]

Don't use pre-built wheels for these packages

Examples: "true", "false"
no-build boolean | string[]

Packages that should NOT be built

Examples: "true", "false"
no-build-isolation boolean | string[]

Packages that should NOT be isolated during the build process

Examples: ["numpy"], true
prerelease-mode string | string | string | string | string

The strategy to use when considering pre-release versions

Examples: "disallow", "allow", "if-necessary", "explicit", "if-necessary-or-explicit"
skip-wheel-filename-check boolean

Skip wheel filename validation, allowing installation of wheels with version mismatches between filename and metadata

Examples: true, false
solve-strategy string

The strategy used to solve packages.

Values: "highest" "lowest" "lowest-direct"
system-requirements object

Platform-specific requirements

6 nested properties
archspec string

The architecture the project supports

minLength=1
cuda number | string

The minimum version of CUDA

libc LibcFamily | number | string

The minimum version of libc

linux number | string

The minimum version of the Linux kernel

macos number | string

The minimum version of MacOS

unix boolean | string

Whether the project supports UNIX

Examples: "true"
target Record<string, object>

Machine-specific aspects of this feature

Examples: {"linux":{"dependencies":{"python":"3.8"}}}
tasks object

The tasks provided by this feature

FindLinksPath object

The path to the directory containing packages

path string

Path to the directory of packages

Examples: "./links"
minLength=1
FindLinksURL object

The URL to the html file containing href-links to packages

url string

URL to html file with href-links to packages

Examples: "https://simple-index-is-here.com"
minLength=1
LibcFamily object
family string

The family of the libc

Examples: "glibc", "musl"
minLength=1
version number | string

The version of libc

MatchspecTable object

A precise description of a conda package version.

branch string

A git branch to use

minLength=1
build string

The build string of the package

minLength=1
build-number string

The build number of the package, can be a spec like >=1 or <=10 or 1

minLength=1
channel string

The channel the packages needs to be fetched from

Examples: "conda-forge", "pytorch", "https://prefix.dev/conda-forge"
minLength=1
file-name string

The file name of the package

minLength=1
git string

The git URL to the repo

minLength=1
license string

The license of the package

minLength=1
md5 string

The md5 hash of the package

pattern=^[a-fA-F0-9]{32}$
path string

The path to the package

minLength=1
rev string

A git SHA revision to use

minLength=1
sha256 string

The sha256 hash of the package

pattern=^[a-fA-F0-9]{64}$
subdir string

The subdir of the package, also known as platform

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
url string

The URL to the package

minLength=1
version string

The version of the package in MatchSpec format

minLength=1
Package object

The package's metadata information.

build object required
6 nested properties
backend object required
19 nested properties
additional-dependencies Record<string, string | MatchspecTable>

Additional dependencies to install alongside the build backend

branch string

A git branch to use

minLength=1
build string

The build string of the package

minLength=1
build-number string

The build number of the package, can be a spec like >=1 or <=10 or 1

minLength=1
channel string

The channel the packages needs to be fetched from

Examples: "conda-forge", "pytorch", "https://prefix.dev/conda-forge"
minLength=1
channels string | string | ChannelInlineTable[]

The conda channels that are used to fetch the build backend from

file-name string

The file name of the package

minLength=1
git string

The git URL to the repo

minLength=1
license string

The license of the package

minLength=1
md5 string

The md5 hash of the package

pattern=^[a-fA-F0-9]{32}$
name string

The name of the build backend package

minLength=1
path string

The path to the package

minLength=1
rev string

A git SHA revision to use

minLength=1
sha256 string

The sha256 hash of the package

pattern=^[a-fA-F0-9]{64}$
subdir string

The subdir of the package, also known as platform

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
url string

The URL to the package

minLength=1
version string

The version of the package in MatchSpec format

minLength=1
additional-dependencies Record<string, string | MatchspecTable>

Additional dependencies to install alongside the build backend

channels string | string | ChannelInlineTable[]

The conda channels that are used to fetch the build backend from

config object

The configuration of the build backend

source object

The location of a package's source code.

6 nested properties
branch string

A git branch to use

minLength=1
git string

The git URL to the source repo

minLength=1
path string

The path to the source

minLength=1
rev string

A git SHA revision to use

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
target Record<string, object>

Target-specific build configuration for different platforms

Examples: {"linux-64":{"config":{"key":"value"}}}
authors string[] | WorkspaceInheritance

The authors of the project. Can be a list of strings or { workspace = true } to inherit from workspace

Examples: ["John Doe <[email protected]>"], {"workspace":true}
build-dependencies Record<string, string | MatchspecTable>

The build conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

description string | WorkspaceInheritance

A short description of the project. Can be a string or { workspace = true } to inherit from workspace

documentation string | WorkspaceInheritance

The URL of the documentation of the project. Can be a URL or { workspace = true } to inherit from workspace

homepage string | WorkspaceInheritance

The URL of the homepage of the project. Can be a URL or { workspace = true } to inherit from workspace

host-dependencies Record<string, string | MatchspecTable>

The host conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

Examples: {"python":">=3.8"}
license string | WorkspaceInheritance

The license of the project; we advise using an SPDX identifier. Can be a string or { workspace = true } to inherit from workspace

license-file string | WorkspaceInheritance

The path to the license file of the project. Can be a path or { workspace = true } to inherit from workspace

name string | WorkspaceInheritance

The name of the package. Can be a string or { workspace = true } to inherit from workspace

readme string | WorkspaceInheritance

The path to the readme file of the project. Can be a path or { workspace = true } to inherit from workspace

repository string | WorkspaceInheritance

The URL of the repository of the project. Can be a URL or { workspace = true } to inherit from workspace

run-dependencies Record<string, string | MatchspecTable>

The conda dependencies required at runtime. See https://pixi.sh/latest/build/dependency_types/ for more information.

target Record<string, object>

Machine-specific aspects of the package

Examples: {"linux":{"host-dependencies":{"python":"3.8"}}}
version string | WorkspaceInheritance

The version of the project; we advise use of SemVer. Can be a string or { workspace = true } to inherit from workspace

Examples: "1.2.3", {"workspace":true}
Platform string

A supported operating system and processor architecture pair.

PyPIGitBranchRequirement object
branch string

A git branch to use

minLength=1
extras string[]

The PEP 508 extras of the package

git string

The git URL to the repo e.g https://github.com/prefix-dev/pixi

minLength=1
subdirectory string

The subdirectory in the repo, a path from the root of the repo.

minLength=1
PyPIGitRevRequirement object
extras string[]

The PEP 508 extras of the package

git string

The git URL to the repo e.g https://github.com/prefix-dev/pixi

minLength=1
rev string

A git SHA revision to use

minLength=1
subdirectory string

The subdirectory in the repo, a path from the root of the repo.

minLength=1
PyPIGitTagRequirement object
extras string[]

The PEP 508 extras of the package

git string

The git URL to the repo e.g https://github.com/prefix-dev/pixi

minLength=1
subdirectory string

The subdirectory in the repo, a path from the root of the repo.

minLength=1
tag string

A git tag to use

minLength=1
PyPIOptions object

Options that determine the behavior of PyPI package resolution and installation

dependency-overrides Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

A list of PyPI dependencies that override the resolved dependencies

Examples: {"numpy":">=1.21.0"}
extra-index-urls string[]

Additional PyPI registries that should be used as extra indexes

Examples: ["https://pypi.org/simple"]
find-links FindLinksPath | FindLinksURL[]

Paths to directory containing

Examples: ["https://pypi.org/simple"]
index-strategy string | string | string

The strategy to use when resolving packages from multiple indexes

Examples: "first-index", "unsafe-first-match", "unsafe-best-match"
index-url string

PyPI registry that should be used as the primary index

Examples: "https://pypi.org/simple"
minLength=1
no-binary boolean | string[]

Don't use pre-built wheels for these packages

Examples: "true", "false"
no-build boolean | string[]

Packages that should NOT be built

Examples: "true", "false"
no-build-isolation boolean | string[]

Packages that should NOT be isolated during the build process

Examples: ["numpy"], true
prerelease-mode string | string | string | string | string

The strategy to use when considering pre-release versions

Examples: "disallow", "allow", "if-necessary", "explicit", "if-necessary-or-explicit"
skip-wheel-filename-check boolean

Skip wheel filename validation, allowing installation of wheels with version mismatches between filename and metadata

Examples: true, false
PyPIPathRequirement object
editable boolean

If true the package will be installed as editable

extras string[]

The PEP 508 extras of the package

path string

A path to a local source or wheel

minLength=1
subdirectory string

The subdirectory in the repo, a path from the root of the repo.

minLength=1
PyPIUrlRequirement object
extras string[]

The PEP 508 extras of the package

url string

A URL to a remote source or wheel

minLength=1
PyPIVersion object
extras string[]

The PEP 508 extras of the package

index string

The index to fetch the package from

minLength=1
version string

The version of the package in PEP 440 format

minLength=1
S3Options object

Options related to S3 for this project

endpoint-url string required

The endpoint URL to use for the S3 client

Examples: "https://s3.eu-central-1.amazonaws.com"
minLength=1
force-path-style boolean required

Whether to force path style for the S3 client

region string required

The region to use for the S3 client

Examples: "eu-central-1"
minLength=1
SolveStrategy string

The strategy used to solve packages.

SourceLocation object

The location of a package's source code.

branch string

A git branch to use

minLength=1
git string

The git URL to the source repo

minLength=1
path string

The path to the source

minLength=1
rev string

A git SHA revision to use

minLength=1
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
SourceSpecTable object

A precise description of a source package location.

branch string

A git branch to use

minLength=1
git string

The git URL to the source repo

minLength=1
md5 string

The md5 hash of the source package

pattern=^[a-fA-F0-9]{32}$
path string

The path to the source package

minLength=1
rev string

A git SHA revision to use

minLength=1
sha256 string

The sha256 hash of the source package

pattern=^[a-fA-F0-9]{64}$
subdirectory string

A subdirectory to use in the repo

minLength=1
tag string

A git tag to use

minLength=1
url string

The URL to the source package

minLength=1
SystemRequirements object

Platform-specific requirements

archspec string

The architecture the project supports

minLength=1
cuda number | string

The minimum version of CUDA

libc LibcFamily | number | string

The minimum version of libc

linux number | string

The minimum version of the Linux kernel

macos number | string

The minimum version of MacOS

unix boolean | string

Whether the project supports UNIX

Examples: "true"
Target object

A machine-specific configuration of dependencies and tasks

activation object

A description of steps performed when an environment is activated

2 nested properties
env Record<string, string>

A map of environment variables to values, used in the activation of the environment. These will be set in the shell. Thus these variables are shell specific. Using '$' might not expand to a value in different shells.

Examples: {"key":"value"}, {"ARGUMENT":"value"}
scripts string[]

The scripts to run when the environment is activated

Examples: "activate.sh", "activate.bat"
build-dependencies Record<string, string | MatchspecTable>

The build conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

constraints Record<string, string | MatchspecTable>

The conda version constraints. These constrain the versions of packages that may be installed without explicitly requiring them. If the package is installed as a dependency of another package, it must satisfy these constraints.

dependencies Record<string, string | MatchspecTable>

The conda dependencies, consisting of a package name and a requirement in MatchSpec format

dev Record<string, object>

Source packages whose dependencies should be installed without building the package itself. Useful for development environments.

host-dependencies Record<string, string | MatchspecTable>

The host conda dependencies, used in the build process. See https://pixi.sh/latest/build/dependency_types/ for more information.

Examples: {"python":">=3.8"}
pypi-dependencies Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

The PyPI dependencies for this target

tasks object

The tasks of the target

TaskArgs object

The arguments of a task.

arg string required

The name of the argument

pattern=^[a-zA-Z_][a-zA-Z0-9_]*$
choices string[]

Allowed values for the argument

minItems=1
default string

The default value of the argument

TaskInlineTable object

A precise definition of a task.

args TaskArgs | string[]

The arguments to a task

Examples: ["arg1","arg2"], ["arg",{"arg":"arg2","default":"2"}], ["arg",{"arg":"arg2","choices":["1","2","4"],"default":"2"}]
clean-env boolean

Whether to run in a clean environment, removing all environment variables except those defined in env and by pixi itself.

cmd string[] | string

A shell command to run the task in the limited, but cross-platform bash-like deno_task_shell. See the documentation for supported syntax

cwd string

The working directory to run the task

pattern=^[^\\]+$
default-environment string

A default environment to run the task

pattern=^[a-z0-9\-]+$
depends-on DependsOn | string[] | DependsOn | string

The tasks that this task depends on. Environment variables will not be expanded.

depends_on string[] | string

The tasks that this task depends on. Environment variables will not be expanded. Deprecated in favor of depends-on from v0.21.0 onward.

description string

A short description of the task

minLength=1
env Record<string, string>

A map of environment variables to values, used in the task, these will be overwritten by the shell.

Examples: {"key":"value"}, {"ARGUMENT":"value"}
inputs string[]

A list of .gitignore-style glob patterns that should be watched for changes before this command is run. Environment variables will be expanded.

outputs string[]

A list of .gitignore-style glob patterns that are generated by this command. Environment variables will be expanded.

Workspace object

The project's metadata information.

channels string | string | ChannelInlineTable[] required

The conda channels that can be used in the project. Unless overridden by priority, the first channel listed will be preferred.

authors string[]

The authors of the project

Examples: "John Doe <[email protected]>"
build-variants Record<string, string[]>

The build variants of the project

build-variants-files string[]

Ordered list of variant definition files.

channel-priority string

The priority of the channel.

Values: "disabled" "strict"
conda-pypi-map Record<string, string | string>

The conda to PyPI mapping configuration

description string

A short description of the project

minLength=1
documentation string

The URL of the documentation of the project

format=uriminLength=1
exclude-newer string

Exclude any package newer than this date

Examples: "2023-11-03", "2023-11-03T03:33:12Z"
pattern=^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2}))?$
homepage string

The URL of the homepage of the project

format=uriminLength=1
license string

The license of the project; we advise using an SPDX identifier.

minLength=1
license-file string

The path to the license file of the project

pattern=^[^\\]+$
name string

The name of the project; we advise use of the name of the repository

minLength=1
platforms Platform[]

The platforms that the project supports

preview string | string[] | boolean

Defines the enabling of preview features of the project

pypi-options object

Options that determine the behavior of PyPI package resolution and installation

10 nested properties
dependency-overrides Record<string, string | PyPIVersion | PyPIGitBranchRequirement | PyPIGitTagRequirement | PyPIGitRevRequirement | PyPIPathRequirement | PyPIUrlRequirement>

A list of PyPI dependencies that override the resolved dependencies

Examples: {"numpy":">=1.21.0"}
extra-index-urls string[]

Additional PyPI registries that should be used as extra indexes

Examples: ["https://pypi.org/simple"]
find-links FindLinksPath | FindLinksURL[]

Paths to directory containing

Examples: ["https://pypi.org/simple"]
index-strategy string | string | string

The strategy to use when resolving packages from multiple indexes

Examples: "first-index", "unsafe-first-match", "unsafe-best-match"
index-url string

PyPI registry that should be used as the primary index

Examples: "https://pypi.org/simple"
minLength=1
no-binary boolean | string[]

Don't use pre-built wheels for these packages

Examples: "true", "false"
no-build boolean | string[]

Packages that should NOT be built

Examples: "true", "false"
no-build-isolation boolean | string[]

Packages that should NOT be isolated during the build process

Examples: ["numpy"], true
prerelease-mode string | string | string | string | string

The strategy to use when considering pre-release versions

Examples: "disallow", "allow", "if-necessary", "explicit", "if-necessary-or-explicit"
skip-wheel-filename-check boolean

Skip wheel filename validation, allowing installation of wheels with version mismatches between filename and metadata

Examples: true, false
readme string

The path to the readme file of the project

pattern=^[^\\]+$
repository string

The URL of the repository of the project

format=uriminLength=1
requires-pixi string

The required version spec for pixi itself to resolve and build the project.

Examples: ">=0.40"
minLength=1
s3-options Record<string, object>

Options related to S3 for this project

solve-strategy string

The strategy used to solve packages.

Values: "highest" "lowest" "lowest-direct"
target Record<string, object>

The workspace targets

version string

The version of the project; we advise use of SemVer

Examples: "1.2.3"
minLength=1
WorkspaceInheritance object

Indicates that a field should inherit its value from the workspace.

workspace boolean required

Must be true to inherit from workspace

Constant: true
WorkspaceTarget object

Target-specific configuration for a workspace

build-variants Record<string, string[]>

The build variants for this workspace target