id       = "pixi"
name     = "Pixi"
homepage = "https://pixi.sh"
description = "Package management made easy!"
executables   = ["pixi"]

[dotfiles]

# Pixi's own diagnostic output in https://github.com/prefix-dev/pixi/issues/6633
# shows it loading the user files ~/.pixi/config.toml and
# ~/Library/Application Support/pixi/config.toml on macOS. The same source
# logs ~/.config/pixi/config.toml on Linux (https://github.com/prefix-dev/pixi/
# discussions/1674). These are the native and XDG config spellings.
paths = [
  "[appData]/pixi/config.toml",
  "~/.pixi/config.toml",
  "[configHome]/pixi/config.toml",
]

# Pixi's documented auth storage is ~/.rattler/credentials.json on Unix:
# https://github.com/prefix-dev/setup-pixi/blob/main/.github/workflows/test.yml
# and newer pixi info output. Older pixi info output in
# https://github.com/prefix-dev/pixi/issues/5424 used ~/rattler-auth.json;
# both are listed because the path moved between releases. Each contains
# registry tokens.
secret = ["~/.rattler/credentials.json", "~/rattler-auth.json"]

[commands]
format = 1
label = "Pixi"
description = "Run a task or command inside the workspace environment. Other subcommands are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand]]
path = ["run"]
label = "Run a task"

[[commands.subcommand.source]]
id = "ref"
kind = "help"
url = "https://pixi.sh/latest/reference/cli/pixi/run/"
revision = "2026-10-27"
evidence = """
<TASK> The pixi task or a task shell command you want to run in the workspace's environment, which can be an executable in the environment's PATH
--executable (-x) Execute the command as an executable without resolving Pixi tasks
--environment (-e) <ENVIRONMENT> The environment to run the task in
--clean-env Use a clean environment to run the task
--skip-deps Don't run the dependencies of the task ('depends-on' field in the task definition)
--dry-run (-n) Run the task in dry-run mode (only print the command that would run)
--frozen Install the environment as defined in the lock file, doesn't update lock file if it isn't up-to-date with the manifest file
--locked Check if lock file is up-to-date before installing the environment, aborts when lock file isn't up-to-date with the manifest file
--manifest-path (-m) <MANIFEST_PATH> The path to pixi.toml, pyproject.toml, or the workspace directory
"""

[[commands.subcommand.field]]
id = "task"
label = "Task and arguments"
type = "string"
position = 0
multiple = true
sources = ["ref"]

[[commands.subcommand.field]]
id = "environment"
label = "Environment"
type = "string"
option = ["--environment", "-e"]
sources = ["ref"]

[[commands.subcommand.field]]
id = "manifest_path"
label = "Manifest or workspace"
type = "path"
option = ["--manifest-path", "-m"]
path = { kind = "any", role = "input" }
sources = ["ref"]

[[commands.subcommand.field]]
id = "dry_run"
label = "Dry run"
type = "boolean"
option = ["--dry-run", "-n"]
sources = ["ref"]

[[commands.subcommand.field]]
id = "executable"
label = "Run as executable"
type = "boolean"
option = ["--executable", "-x"]
sources = ["ref"]

[[commands.subcommand.field]]
id = "clean_env"
label = "Clean environment"
type = "boolean"
option = ["--clean-env"]
sources = ["ref"]

[[commands.subcommand.field]]
id = "skip_deps"
label = "Skip task dependencies"
type = "boolean"
option = ["--skip-deps"]
sources = ["ref"]

[[commands.subcommand.field]]
id = "frozen"
label = "Use lock file as is"
type = "boolean"
option = ["--frozen"]
sources = ["ref"]

[[commands.subcommand.field]]
id = "locked"
label = "Require up-to-date lock file"
type = "boolean"
option = ["--locked"]
sources = ["ref"]

[[commands.subcommand.task]]
id = "run"
label = "Run a task"
fields = ["task", "environment", "dry_run", "manifest_path"]
required = ["task"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["task", "environment", "manifest_path", "dry_run"]

[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["executable", "clean_env", "skip_deps", "frozen", "locked"]