Back to Pixi

pixi workspace register

docs/reference/cli/pixi/workspace/register/index.md

0.76.21.9 KB
Original Source
<!--- This file is autogenerated. Do not edit manually! -->

pixi workspace register

Commands to manage the registry of workspaces. Default command will add a new workspace

--8<-- "docs/reference/cli/pixi/workspace/register_extender:description"

Usage

pixi workspace register [OPTIONS] [COMMAND]

Subcommands

CommandDescription
listList the registered workspaces
removeRemove a workspace from registry
prunePrune disassociated workspaces from registry

Options

  • <a id="arg---name" href="#arg---name">--name (-n) <NAME></a> : Name of the workspace to register. Defaults to the name of the current workspace
  • <a id="arg---path" href="#arg---path">--path (-p) <PATH></a> : Path to register. Defaults to the path to the current workspace
  • <a id="arg---force" href="#arg---force">--force (-f)</a> : Overwrite the workspace entry if the name of the workspace already exists in the registry

Config Options

  • <a id="arg---no-config" href="#arg---no-config">--no-config</a> : Don't read system or user-level configuration files. Project-local <project>/.pixi/config.toml is still loaded

env: PIXI_NO_CONFIG

default: false

  • <a id="arg---config-file" href="#arg---config-file">--config-file <PATH></a> : Load configuration from this file instead of searching system and user-level paths. Project-local <project>/.pixi/config.toml is still merged on top

env: PIXI_CONFIG_FILE

Global Options

  • <a id="arg---manifest-path" href="#arg---manifest-path">--manifest-path (-m) <MANIFEST_PATH></a> : The path to pixi.toml, pyproject.toml, or the workspace directory
  • <a id="arg---workspace" href="#arg---workspace">--workspace (-w) <WORKSPACE></a> : Name of the workspace

--8<-- "docs/reference/cli/pixi/workspace/register_extender:example"