Skip to content

Commit

Permalink
Merge branch 'main' into refactor/pypi_mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
baszalmstra authored Mar 11, 2025
2 parents 18e84cc + 98d1ebe commit 8a192a0
Show file tree
Hide file tree
Showing 165 changed files with 715 additions and 903 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ jobs:
# Check if there are any changes
if ! git diff --quiet; then
echo "Error: Generated CLI documentation differs from committed version"
echo "Please run 'pixi run generate-cli-docs' to regenerate the documentation and commit the changes."
git diff
exit 1
fi
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/pixi.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ pixi [OPTIONS] <COMMAND>
| [`exec`](pixi/exec.md) | Run a command and install it in a temporary environment |
| [`shell`](pixi/shell.md) | Start a shell in a pixi environment, run `exit` to leave the shell |
| [`shell-hook`](pixi/shell-hook.md) | Print the pixi environment activation script |
| [`project`](pixi/project.md) | Modify the project configuration file through the command line |
| [`workspace`](pixi/workspace.md) | Modify the workspace configuration file through the command line |
| [`task`](pixi/task.md) | Interact with tasks in the workspace |
| [`list`](pixi/list.md) | List project's packages |
| [`tree`](pixi/tree.md) | Show a tree of project dependencies |
| [`list`](pixi/list.md) | List workspace's packages |
| [`tree`](pixi/tree.md) | Show a tree of workspace dependencies |
| [`global`](pixi/global.md) | Subcommand for global package management actions |
| [`auth`](pixi/auth.md) | Login to prefix.dev or anaconda.org servers to access private channels |
| [`config`](pixi/config.md) | Configuration management |
| [`info`](pixi/info.md) | Information about the system, project and environments for the current machine |
| [`info`](pixi/info.md) | Information about the system, workspace and environments for the current machine |
| [`upload`](pixi/upload.md) | Upload a conda package |
| [`search`](pixi/search.md) | Search a conda package |
| [`self-update`](pixi/self-update.md) | Update pixi to the latest version or a specific version |
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/pixi/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ pixi add [OPTIONS] <SPECS>...

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
Adds dependencies to the workspace

The dependencies should be defined as MatchSpec for conda package, or a PyPI
requirement for the `--pypi` dependencies. If no specific version is
provided, the latest version compatible with your project will be chosen
provided, the latest version compatible with your workspace will be chosen
automatically or a * will be used.

Example usage:
Expand All @@ -87,7 +87,7 @@ Example usage:
Adding multiple dependencies at once is also supported:

- `pixi add python pytest`: This will add both `python` and `pytest` to the
project's dependencies.
workspace's dependencies.

The `--platform` and `--build/--host` flags make the dependency target
specific.
Expand All @@ -105,7 +105,7 @@ be mixed with the conda dependencies
- `pixi add --pypi boto3`
- `pixi add --pypi "boto3==version"`

If the project manifest is a `pyproject.toml`, adding a pypi dependency will
If the workspace manifest is a `pyproject.toml`, adding a pypi dependency will
add it to the native pyproject `project.dependencies` array or to the native
`dependency-groups` table if a feature is specified:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/add_extender.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
pixi add numpy # (1)!
pixi add numpy pandas "pytorch>=1.8" # (2)!
pixi add "numpy>=1.22,<1.24" # (3)!
pixi add --manifest-path ~/myproject/pixi.toml numpy # (4)!
pixi add --manifest-path ~/myworkspace/pixi.toml numpy # (4)!
pixi add --host "python>=3.9.0" # (5)!
pixi add --build cmake # (6)!
pixi add --platform osx-64 clang # (7)!
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ pixi build [OPTIONS]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

--8<-- "docs/reference/cli/pixi/build_extender.md:example"
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pixi clean [OPTIONS] [COMMAND]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
Cleanup the environments.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/config/append.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ pixi config append [OPTIONS] <KEY> <VALUE>

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
Append a value to a list configuration key
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/config/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ pixi config edit [OPTIONS] [EDITOR]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

--8<-- "docs/reference/cli/pixi/config/edit_extender.md:example"
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/config/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pixi config list [OPTIONS] [KEY]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
List configuration values
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/config/prepend.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ pixi config prepend [OPTIONS] <KEY> <VALUE>

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
Prepend a value to a list configuration key
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/config/set.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ pixi config set [OPTIONS] <KEY> [VALUE]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
Set a configuration value
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/config/unset.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pixi config unset [OPTIONS] <KEY>

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
Unset a configuration value
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/global/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ pixi global install [OPTIONS] <PACKAGES>...
- <a id="arg---expose" href="#arg---expose">`--expose <EXPOSE>`</a>
: Add one or more mapping which describe which executables are exposed. The syntax is `exposed_name=executable_name`, so for example `python3.10=python`. Alternatively, you can input only an executable_name and `executable_name=executable_name` is assumed
- <a id="arg---force-reinstall" href="#arg---force-reinstall">`--force-reinstall`</a>
: Specifies that the packages should be reinstalled even if they are already installed
: Specifies that the environment should be reinstalled
- <a id="arg---no-shortcut" href="#arg---no-shortcut">`--no-shortcut`</a>
: Specifies that no shortcuts should be created for the installed packages
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli/pixi/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# <code>[pixi](../pixi.md) info</code>

## About
Information about the system, project and environments for the current machine
Information about the system, workspace and environments for the current machine

--8<-- "docs/reference/cli/pixi/info_extender.md:description"

Expand All @@ -19,6 +19,6 @@ pixi info [OPTIONS]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

--8<-- "docs/reference/cli/pixi/info_extender.md:example"
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pixi install [OPTIONS]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
Install an environment, both updating the lockfile and installing the environment.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/install_extender.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```shell
pixi install # (1)!
pixi install --manifest-path ~/myproject/pixi.toml # (2)!
pixi install --manifest-path ~/myworkspace/pixi.toml # (2)!
pixi install --frozen # (3)!
pixi install --locked # (4)!
pixi install --environment lint # (5)!
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/pixi/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# <code>[pixi](../pixi.md) list</code>

## About
List project's packages
List workspace's packages

--8<-- "docs/reference/cli/pixi/list_extender.md:description"

Expand All @@ -25,7 +25,7 @@ pixi list [OPTIONS] [REGEX]
- <a id="arg---environment" href="#arg---environment">`--environment (-e) <ENVIRONMENT>`</a>
: The environment to list packages for. Defaults to the default environment
- <a id="arg---explicit" href="#arg---explicit">`--explicit (-x)`</a>
: Only list packages that are explicitly defined in the project
: Only list packages that are explicitly defined in the workspace
- <a id="arg---frozen" href="#arg---frozen">`--frozen`</a>
: Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file
<br>**env**: `PIXI_FROZEN`
Expand Down Expand Up @@ -56,10 +56,10 @@ pixi list [OPTIONS] [REGEX]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

## Description
List project's packages.
List workspace's packages.

Highlighted packages are explicit dependencies.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/lock.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ pixi lock [OPTIONS]

## Global Options
- <a id="arg---manifest-path" href="#arg---manifest-path">`--manifest-path <MANIFEST_PATH>`</a>
: The path to `pixi.toml`, `pyproject.toml`, or the project directory
: The path to `pixi.toml`, `pyproject.toml`, or the workspace directory

--8<-- "docs/reference/cli/pixi/lock_extender.md:example"
2 changes: 1 addition & 1 deletion docs/reference/cli/pixi/lock_extender.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```shell
pixi lock
pixi lock --manifest-path ~/myproject/pixi.toml
pixi lock --manifest-path ~/myworkspace/pixi.toml
pixi lock --json
```

Expand Down
31 changes: 0 additions & 31 deletions docs/reference/cli/pixi/project.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/reference/cli/pixi/project/channel.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/reference/cli/pixi/project/channel/add_extender.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/reference/cli/pixi/project/channel/list.md

This file was deleted.

21 changes: 0 additions & 21 deletions docs/reference/cli/pixi/project/channel/list_extender.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/reference/cli/pixi/project/channel/remove_extender.md

This file was deleted.

25 changes: 0 additions & 25 deletions docs/reference/cli/pixi/project/description.md

This file was deleted.

Loading

0 comments on commit 8a192a0

Please sign in to comment.