This is page 1 of 14. Use http://codebase.md/keminghe/python-dependency-manager-companion-mcp-server?page={x} to view the full context.
# Directory Structure
```
├── .dockerignore
├── .github
│ ├── ISSUE_TEMPLATE
│ │ ├── bug-report.md
│ │ ├── config.yml
│ │ └── feature-request.md
│ ├── pull_request_template.md
│ └── workflows
│ ├── auto-update-docs.yml
│ ├── auto-update-index.yml
│ ├── auto-update-publish.yml
│ ├── auto-update.yml
│ ├── codeql.yml
│ ├── README-codeql.md
│ └── README.md
├── .gitignore
├── .python-version
├── CONTRIBUTING.md
├── Dockerfile
├── docs
│ └── assets
│ ├── 2025-07-27-demo-source.mp4
│ ├── 2025-07-27-demo-thumbnail.png
│ └── 2025-07-27-demo.mp4
├── LICENSE
├── prompts
│ ├── prompt-commit-msg-gen.md
│ ├── prompt-issue-gen.md
│ ├── prompt-pull-request-gen.md
│ └── prompt-readme-gen.md
├── pyproject.toml
├── README-dockerhub.md
├── README.md
├── scripts
│ ├── clean-assets-design.md
│ └── clean-assets.sh
├── src
│ ├── assets
│ │ ├── conda
│ │ │ ├── _metadata.json
│ │ │ └── source
│ │ │ ├── _templates
│ │ │ │ └── autoapi
│ │ │ │ └── python
│ │ │ │ └── module.rst
│ │ │ ├── commands
│ │ │ │ ├── activate.rst
│ │ │ │ ├── clean.rst
│ │ │ │ ├── commands.rst
│ │ │ │ ├── compare.rst
│ │ │ │ ├── config.rst
│ │ │ │ ├── create.rst
│ │ │ │ ├── deactivate.rst
│ │ │ │ ├── doctor.rst
│ │ │ │ ├── export.rst
│ │ │ │ ├── index.rst
│ │ │ │ ├── info.rst
│ │ │ │ ├── init.rst
│ │ │ │ ├── install.rst
│ │ │ │ ├── list.rst
│ │ │ │ ├── notices.rst
│ │ │ │ ├── package.rst
│ │ │ │ ├── remove.rst
│ │ │ │ ├── rename.rst
│ │ │ │ ├── repoquery
│ │ │ │ │ ├── depends.rst
│ │ │ │ │ ├── index.rst
│ │ │ │ │ ├── search.rst
│ │ │ │ │ └── whoneeds.rst
│ │ │ │ ├── run.rst
│ │ │ │ ├── search.rst
│ │ │ │ └── update.rst
│ │ │ ├── configuration.rst
│ │ │ ├── dev-guide
│ │ │ │ ├── api.rst
│ │ │ │ ├── architecture.rst
│ │ │ │ ├── contributing.md
│ │ │ │ ├── deep-dives
│ │ │ │ │ ├── activation.md
│ │ │ │ │ ├── condarc.md
│ │ │ │ │ ├── context.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── install.md
│ │ │ │ │ ├── logging.md
│ │ │ │ │ └── solvers.md
│ │ │ │ ├── deprecations.md
│ │ │ │ ├── development-environment.md
│ │ │ │ ├── index.rst
│ │ │ │ ├── plugins
│ │ │ │ │ ├── auth_handlers.rst
│ │ │ │ │ ├── environment_exporters.rst
│ │ │ │ │ ├── environment_specifiers.rst
│ │ │ │ │ ├── health_checks.rst
│ │ │ │ │ ├── index.rst
│ │ │ │ │ ├── post_commands.rst
│ │ │ │ │ ├── post_transaction_actions.rst
│ │ │ │ │ ├── pre_commands.rst
│ │ │ │ │ ├── pre_transaction_actions.rst
│ │ │ │ │ ├── prefix_data_loaders.rst
│ │ │ │ │ ├── reporter_backends.rst
│ │ │ │ │ ├── request_headers.rst
│ │ │ │ │ ├── settings.rst
│ │ │ │ │ ├── solvers.rst
│ │ │ │ │ ├── subcommands.rst
│ │ │ │ │ └── virtual_packages.rst
│ │ │ │ ├── releasing.md
│ │ │ │ ├── specs
│ │ │ │ │ ├── index.md
│ │ │ │ │ └── solver-state.md
│ │ │ │ └── writing-tests
│ │ │ │ ├── http-test-server.md
│ │ │ │ ├── index.rst
│ │ │ │ ├── integration-tests.md
│ │ │ │ └── windows-applocker.md
│ │ │ ├── glossary.rst
│ │ │ ├── index.rst
│ │ │ ├── release-notes.md
│ │ │ └── user-guide
│ │ │ ├── cheatsheet.rst
│ │ │ ├── concepts
│ │ │ │ ├── channels.rst
│ │ │ │ ├── conda-commands.rst
│ │ │ │ ├── conda-performance.rst
│ │ │ │ ├── conda-plugins.rst
│ │ │ │ ├── data-science.rst
│ │ │ │ ├── environments.rst
│ │ │ │ ├── index.rst
│ │ │ │ ├── installing-with-conda.rst
│ │ │ │ ├── packages.rst
│ │ │ │ ├── pkg-search.rst
│ │ │ │ └── pkg-specs.rst
│ │ │ ├── conda-cheatsheet.pdf
│ │ │ ├── configuration
│ │ │ │ ├── admin-multi-user-install.rst
│ │ │ │ ├── custom-env-and-pkg-locations.rst
│ │ │ │ ├── disable-ssl-verification.rst
│ │ │ │ ├── free-channel.rst
│ │ │ │ ├── index.rst
│ │ │ │ ├── mirroring.rst
│ │ │ │ ├── non-standard-certs.rst
│ │ │ │ ├── pip-interoperability.rst
│ │ │ │ ├── settings.rst
│ │ │ │ ├── temp-files.rst
│ │ │ │ └── use-condarc.rst
│ │ │ ├── getting-started.rst
│ │ │ ├── index.rst
│ │ │ ├── install
│ │ │ │ ├── index.rst
│ │ │ │ ├── linux.rst
│ │ │ │ ├── macos.rst
│ │ │ │ ├── rpm-debian.rst
│ │ │ │ └── windows.rst
│ │ │ ├── tasks
│ │ │ │ ├── create-custom-channels.rst
│ │ │ │ ├── creating-projects.rst
│ │ │ │ ├── index.rst
│ │ │ │ ├── manage-channels.rst
│ │ │ │ ├── manage-conda.rst
│ │ │ │ ├── manage-environments.rst
│ │ │ │ ├── manage-pkgs.rst
│ │ │ │ ├── manage-python.rst
│ │ │ │ ├── manage-virtual.rst
│ │ │ │ └── view-command-line-help.rst
│ │ │ └── troubleshooting.rst
│ │ ├── pdm
│ │ │ ├── _metadata.json
│ │ │ ├── dev
│ │ │ │ ├── benchmark.md
│ │ │ │ ├── changelog.md
│ │ │ │ ├── contributing.md
│ │ │ │ ├── fixtures.md
│ │ │ │ └── write.md
│ │ │ ├── index.md
│ │ │ ├── reference
│ │ │ │ ├── api.md
│ │ │ │ ├── build.md
│ │ │ │ ├── cli.md
│ │ │ │ ├── configuration.md
│ │ │ │ └── pep621.md
│ │ │ └── usage
│ │ │ ├── advanced.md
│ │ │ ├── config.md
│ │ │ ├── dependency.md
│ │ │ ├── hooks.md
│ │ │ ├── lock-targets.md
│ │ │ ├── lockfile.md
│ │ │ ├── pep582.md
│ │ │ ├── project.md
│ │ │ ├── publish.md
│ │ │ ├── scripts.md
│ │ │ ├── template.md
│ │ │ ├── uv.md
│ │ │ └── venv.md
│ │ ├── pip
│ │ │ ├── _metadata.json
│ │ │ ├── html
│ │ │ │ ├── cli
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── pip_cache.rst
│ │ │ │ │ ├── pip_check.rst
│ │ │ │ │ ├── pip_config.rst
│ │ │ │ │ ├── pip_debug.rst
│ │ │ │ │ ├── pip_download.rst
│ │ │ │ │ ├── pip_freeze.rst
│ │ │ │ │ ├── pip_hash.rst
│ │ │ │ │ ├── pip_index.rst
│ │ │ │ │ ├── pip_inspect.rst
│ │ │ │ │ ├── pip_install.rst
│ │ │ │ │ ├── pip_list.rst
│ │ │ │ │ ├── pip_lock.rst
│ │ │ │ │ ├── pip_search.rst
│ │ │ │ │ ├── pip_show.rst
│ │ │ │ │ ├── pip_uninstall.rst
│ │ │ │ │ ├── pip_wheel.rst
│ │ │ │ │ └── pip.rst
│ │ │ │ ├── copyright.rst
│ │ │ │ ├── development
│ │ │ │ │ ├── architecture
│ │ │ │ │ │ ├── anatomy.rst
│ │ │ │ │ │ ├── command-line-interface.rst
│ │ │ │ │ │ ├── configuration-files.rst
│ │ │ │ │ │ ├── index.rst
│ │ │ │ │ │ ├── overview.rst
│ │ │ │ │ │ ├── package-finding.rst
│ │ │ │ │ │ └── upgrade-options.rst
│ │ │ │ │ ├── ci.rst
│ │ │ │ │ ├── contributing.rst
│ │ │ │ │ ├── conventions.rst
│ │ │ │ │ ├── getting-started.rst
│ │ │ │ │ ├── index.rst
│ │ │ │ │ ├── issue-triage.md
│ │ │ │ │ ├── release-process.rst
│ │ │ │ │ └── vendoring-policy.rst
│ │ │ │ ├── getting-started.md
│ │ │ │ ├── index.md
│ │ │ │ ├── installation.md
│ │ │ │ ├── installing.rst
│ │ │ │ ├── news.rst
│ │ │ │ ├── quickstart.rst
│ │ │ │ ├── reference
│ │ │ │ │ ├── build-system
│ │ │ │ │ │ ├── index.md
│ │ │ │ │ │ ├── pyproject-toml.md
│ │ │ │ │ │ └── setup-py.md
│ │ │ │ │ ├── build-system.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── inspect-report.md
│ │ │ │ │ ├── installation-report.md
│ │ │ │ │ ├── pip_cache.rst
│ │ │ │ │ ├── pip_check.rst
│ │ │ │ │ ├── pip_config.rst
│ │ │ │ │ ├── pip_debug.rst
│ │ │ │ │ ├── pip_download.rst
│ │ │ │ │ ├── pip_freeze.rst
│ │ │ │ │ ├── pip_hash.rst
│ │ │ │ │ ├── pip_index.rst
│ │ │ │ │ ├── pip_install.rst
│ │ │ │ │ ├── pip_list.rst
│ │ │ │ │ ├── pip_search.rst
│ │ │ │ │ ├── pip_show.rst
│ │ │ │ │ ├── pip_uninstall.rst
│ │ │ │ │ ├── pip_wheel.rst
│ │ │ │ │ ├── pip.rst
│ │ │ │ │ ├── requirement-specifiers.md
│ │ │ │ │ └── requirements-file-format.md
│ │ │ │ ├── topics
│ │ │ │ │ ├── authentication.md
│ │ │ │ │ ├── caching.md
│ │ │ │ │ ├── configuration.md
│ │ │ │ │ ├── dependency-resolution.md
│ │ │ │ │ ├── https-certificates.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── local-project-installs.md
│ │ │ │ │ ├── more-dependency-resolution.md
│ │ │ │ │ ├── python-option.md
│ │ │ │ │ ├── repeatable-installs.md
│ │ │ │ │ ├── secure-installs.md
│ │ │ │ │ ├── vcs-support.md
│ │ │ │ │ └── workflow.md
│ │ │ │ ├── user_guide.rst
│ │ │ │ └── ux-research-design
│ │ │ │ ├── contribute.md
│ │ │ │ ├── guidance.md
│ │ │ │ ├── index.md
│ │ │ │ ├── research-results
│ │ │ │ │ ├── about-our-users.md
│ │ │ │ │ ├── ci-cd.md
│ │ │ │ │ ├── improving-pips-documentation.md
│ │ │ │ │ ├── index.md
│ │ │ │ │ ├── mental-models.md
│ │ │ │ │ ├── override-conflicting-dependencies.md
│ │ │ │ │ ├── personas.md
│ │ │ │ │ ├── pip-force-reinstall.md
│ │ │ │ │ ├── pip-search.md
│ │ │ │ │ ├── pip-upgrade-conflict.md
│ │ │ │ │ ├── prioritizing-features.md
│ │ │ │ │ └── users-and-security.md
│ │ │ │ └── resolution-impossible-example.md
│ │ │ └── man
│ │ │ ├── commands
│ │ │ │ ├── cache.rst
│ │ │ │ ├── check.rst
│ │ │ │ ├── config.rst
│ │ │ │ ├── debug.rst
│ │ │ │ ├── download.rst
│ │ │ │ ├── freeze.rst
│ │ │ │ ├── hash.rst
│ │ │ │ ├── help.rst
│ │ │ │ ├── index.rst
│ │ │ │ ├── install.rst
│ │ │ │ ├── list.rst
│ │ │ │ ├── lock.rst
│ │ │ │ ├── search.rst
│ │ │ │ ├── show.rst
│ │ │ │ ├── uninstall.rst
│ │ │ │ └── wheel.rst
│ │ │ └── index.rst
│ │ ├── pixi
│ │ │ ├── _metadata.json
│ │ │ ├── advanced
│ │ │ │ ├── channel_logic.md
│ │ │ │ ├── explain_info_command.md
│ │ │ │ ├── override.md
│ │ │ │ ├── pixi_shell.md
│ │ │ │ └── shebang.md
│ │ │ ├── concepts
│ │ │ │ ├── conda_pypi.md
│ │ │ │ └── package_specifications.md
│ │ │ ├── deployment
│ │ │ │ ├── authentication.md
│ │ │ │ ├── container.md
│ │ │ │ ├── pixi_pack.md
│ │ │ │ └── s3.md
│ │ │ ├── first_project.md
│ │ │ ├── first_workspace.md
│ │ │ ├── getting_started.md
│ │ │ ├── global_tools
│ │ │ │ ├── introduction.md
│ │ │ │ ├── manifest.md
│ │ │ │ └── trampolines.md
│ │ │ ├── index.md
│ │ │ ├── installation.md
│ │ │ ├── integration
│ │ │ │ ├── ci
│ │ │ │ │ ├── github_actions.md
│ │ │ │ │ └── updates_github_actions.md
│ │ │ │ ├── editor
│ │ │ │ │ ├── jetbrains.md
│ │ │ │ │ ├── jupyterlab.md
│ │ │ │ │ ├── r_studio.md
│ │ │ │ │ ├── vscode.md
│ │ │ │ │ └── zed.md
│ │ │ │ ├── extensions
│ │ │ │ │ ├── introduction.md
│ │ │ │ │ ├── pixi_diff.md
│ │ │ │ │ ├── pixi_inject.md
│ │ │ │ │ └── pixi_install_to_prefix.md
│ │ │ │ └── third_party
│ │ │ │ ├── conda_deny.md
│ │ │ │ ├── direnv.md
│ │ │ │ └── starship.md
│ │ │ ├── misc
│ │ │ │ ├── Community.md
│ │ │ │ ├── FAQ.md
│ │ │ │ ├── packaging.md
│ │ │ │ └── vision.md
│ │ │ ├── overrides
│ │ │ │ └── override.md
│ │ │ ├── partials
│ │ │ │ └── conda-style-activation.md
│ │ │ ├── python
│ │ │ │ ├── pyproject_toml.md
│ │ │ │ ├── pytorch.md
│ │ │ │ └── tutorial.md
│ │ │ ├── reference
│ │ │ │ ├── cli
│ │ │ │ │ ├── __README.md
│ │ │ │ │ ├── pixi
│ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ ├── auth
│ │ │ │ │ │ │ ├── login.md
│ │ │ │ │ │ │ └── logout.md
│ │ │ │ │ │ ├── auth.md
│ │ │ │ │ │ ├── build.md
│ │ │ │ │ │ ├── clean
│ │ │ │ │ │ │ └── cache.md
│ │ │ │ │ │ ├── clean.md
│ │ │ │ │ │ ├── completion.md
│ │ │ │ │ │ ├── config
│ │ │ │ │ │ │ ├── append.md
│ │ │ │ │ │ │ ├── edit.md
│ │ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ │ ├── prepend.md
│ │ │ │ │ │ │ ├── set.md
│ │ │ │ │ │ │ └── unset.md
│ │ │ │ │ │ ├── config.md
│ │ │ │ │ │ ├── exec.md
│ │ │ │ │ │ ├── global
│ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ ├── edit.md
│ │ │ │ │ │ │ ├── expose
│ │ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ │ └── remove.md
│ │ │ │ │ │ │ ├── expose.md
│ │ │ │ │ │ │ ├── install.md
│ │ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ │ ├── remove.md
│ │ │ │ │ │ │ ├── shortcut
│ │ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ │ └── remove.md
│ │ │ │ │ │ │ ├── shortcut.md
│ │ │ │ │ │ │ ├── sync.md
│ │ │ │ │ │ │ ├── tree.md
│ │ │ │ │ │ │ ├── uninstall.md
│ │ │ │ │ │ │ ├── update.md
│ │ │ │ │ │ │ ├── upgrade-all.md
│ │ │ │ │ │ │ └── upgrade.md
│ │ │ │ │ │ ├── global.md
│ │ │ │ │ │ ├── import.md
│ │ │ │ │ │ ├── info.md
│ │ │ │ │ │ ├── init.md
│ │ │ │ │ │ ├── install.md
│ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ ├── lock.md
│ │ │ │ │ │ ├── reinstall.md
│ │ │ │ │ │ ├── remove.md
│ │ │ │ │ │ ├── run.md
│ │ │ │ │ │ ├── search.md
│ │ │ │ │ │ ├── self-update.md
│ │ │ │ │ │ ├── shell-hook.md
│ │ │ │ │ │ ├── shell.md
│ │ │ │ │ │ ├── task
│ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ ├── alias.md
│ │ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ │ └── remove.md
│ │ │ │ │ │ ├── task.md
│ │ │ │ │ │ ├── tree.md
│ │ │ │ │ │ ├── update.md
│ │ │ │ │ │ ├── upgrade.md
│ │ │ │ │ │ ├── upload
│ │ │ │ │ │ │ ├── anaconda.md
│ │ │ │ │ │ │ ├── artifactory.md
│ │ │ │ │ │ │ ├── conda-forge.md
│ │ │ │ │ │ │ ├── prefix.md
│ │ │ │ │ │ │ ├── quetz.md
│ │ │ │ │ │ │ └── s3.md
│ │ │ │ │ │ ├── upload.md
│ │ │ │ │ │ ├── workspace
│ │ │ │ │ │ │ ├── channel
│ │ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ │ │ └── remove.md
│ │ │ │ │ │ │ ├── channel.md
│ │ │ │ │ │ │ ├── description
│ │ │ │ │ │ │ │ ├── get.md
│ │ │ │ │ │ │ │ └── set.md
│ │ │ │ │ │ │ ├── description.md
│ │ │ │ │ │ │ ├── environment
│ │ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ │ │ └── remove.md
│ │ │ │ │ │ │ ├── environment.md
│ │ │ │ │ │ │ ├── export
│ │ │ │ │ │ │ │ ├── conda-environment.md
│ │ │ │ │ │ │ │ └── conda-explicit-spec.md
│ │ │ │ │ │ │ ├── export.md
│ │ │ │ │ │ │ ├── feature
│ │ │ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ │ │ └── remove.md
│ │ │ │ │ │ │ ├── feature.md
│ │ │ │ │ │ │ ├── name
│ │ │ │ │ │ │ │ ├── get.md
│ │ │ │ │ │ │ │ └── set.md
│ │ │ │ │ │ │ ├── name.md
│ │ │ │ │ │ │ ├── platform
│ │ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ │ ├── list.md
│ │ │ │ │ │ │ │ └── remove.md
│ │ │ │ │ │ │ ├── platform.md
│ │ │ │ │ │ │ ├── requires-pixi
│ │ │ │ │ │ │ │ ├── get.md
│ │ │ │ │ │ │ │ ├── set.md
│ │ │ │ │ │ │ │ ├── unset.md
│ │ │ │ │ │ │ │ └── verify.md
│ │ │ │ │ │ │ ├── requires-pixi.md
│ │ │ │ │ │ │ ├── system-requirements
│ │ │ │ │ │ │ │ ├── add.md
│ │ │ │ │ │ │ │ └── list.md
│ │ │ │ │ │ │ ├── system-requirements.md
│ │ │ │ │ │ │ ├── version
│ │ │ │ │ │ │ │ ├── get.md
│ │ │ │ │ │ │ │ ├── major.md
│ │ │ │ │ │ │ │ ├── minor.md
│ │ │ │ │ │ │ │ ├── patch.md
│ │ │ │ │ │ │ │ └── set.md
│ │ │ │ │ │ │ └── version.md
│ │ │ │ │ │ └── workspace.md
│ │ │ │ │ └── pixi.md
│ │ │ │ ├── environment_variables.md
│ │ │ │ ├── pixi_configuration.md
│ │ │ │ └── pixi_manifest.md
│ │ │ ├── switching_from
│ │ │ │ ├── conda.md
│ │ │ │ └── poetry.md
│ │ │ ├── tutorials
│ │ │ │ ├── import.md
│ │ │ │ ├── multi_environment.md
│ │ │ │ ├── ros2.md
│ │ │ │ └── rust.md
│ │ │ └── workspace
│ │ │ ├── advanced_tasks.md
│ │ │ ├── environment.md
│ │ │ ├── lockfile.md
│ │ │ ├── multi_environment.md
│ │ │ ├── multi_platform_configuration.md
│ │ │ └── system_requirements.md
│ │ ├── poetry
│ │ │ ├── _index.md
│ │ │ ├── _metadata.json
│ │ │ ├── basic-usage.md
│ │ │ ├── building-extension-modules.md
│ │ │ ├── cli.md
│ │ │ ├── community.md
│ │ │ ├── configuration.md
│ │ │ ├── contributing.md
│ │ │ ├── dependency-specification.md
│ │ │ ├── faq.md
│ │ │ ├── libraries.md
│ │ │ ├── managing-dependencies.md
│ │ │ ├── managing-environments.md
│ │ │ ├── plugins.md
│ │ │ ├── pre-commit-hooks.md
│ │ │ ├── pyproject.md
│ │ │ └── repositories.md
│ │ └── uv
│ │ ├── _metadata.json
│ │ ├── concepts
│ │ │ ├── authentication
│ │ │ │ ├── certificates.md
│ │ │ │ ├── cli.md
│ │ │ │ ├── git.md
│ │ │ │ ├── http.md
│ │ │ │ ├── index.md
│ │ │ │ └── third-party.md
│ │ │ ├── authentication.md
│ │ │ ├── build-backend.md
│ │ │ ├── cache.md
│ │ │ ├── configuration-files.md
│ │ │ ├── index.md
│ │ │ ├── indexes.md
│ │ │ ├── preview.md
│ │ │ ├── projects
│ │ │ │ ├── build.md
│ │ │ │ ├── config.md
│ │ │ │ ├── dependencies.md
│ │ │ │ ├── export.md
│ │ │ │ ├── index.md
│ │ │ │ ├── init.md
│ │ │ │ ├── layout.md
│ │ │ │ ├── run.md
│ │ │ │ ├── sync.md
│ │ │ │ └── workspaces.md
│ │ │ ├── python-versions.md
│ │ │ ├── resolution.md
│ │ │ └── tools.md
│ │ ├── getting-started
│ │ │ ├── features.md
│ │ │ ├── first-steps.md
│ │ │ ├── help.md
│ │ │ ├── index.md
│ │ │ └── installation.md
│ │ ├── guides
│ │ │ ├── index.md
│ │ │ ├── install-python.md
│ │ │ ├── integration
│ │ │ │ ├── alternative-indexes.md
│ │ │ │ ├── aws-lambda.md
│ │ │ │ ├── coiled.md
│ │ │ │ ├── dependency-bots.md
│ │ │ │ ├── docker.md
│ │ │ │ ├── fastapi.md
│ │ │ │ ├── github.md
│ │ │ │ ├── gitlab.md
│ │ │ │ ├── index.md
│ │ │ │ ├── jupyter.md
│ │ │ │ ├── marimo.md
│ │ │ │ ├── pre-commit.md
│ │ │ │ └── pytorch.md
│ │ │ ├── migration
│ │ │ │ ├── index.md
│ │ │ │ └── pip-to-project.md
│ │ │ ├── package.md
│ │ │ ├── projects.md
│ │ │ ├── scripts.md
│ │ │ └── tools.md
│ │ ├── index.md
│ │ ├── pip
│ │ │ ├── compatibility.md
│ │ │ ├── compile.md
│ │ │ ├── dependencies.md
│ │ │ ├── environments.md
│ │ │ ├── index.md
│ │ │ ├── inspection.md
│ │ │ └── packages.md
│ │ └── reference
│ │ ├── benchmarks.md
│ │ ├── cli.md
│ │ ├── environment.md
│ │ ├── index.md
│ │ ├── installer.md
│ │ ├── internals
│ │ │ ├── index.md
│ │ │ └── resolver.md
│ │ ├── policies
│ │ │ ├── index.md
│ │ │ ├── license.md
│ │ │ ├── platforms.md
│ │ │ └── versioning.md
│ │ ├── resolver-internals.md
│ │ ├── settings.md
│ │ ├── storage.md
│ │ └── troubleshooting
│ │ ├── build-failures.md
│ │ ├── index.md
│ │ └── reproducible-examples.md
│ ├── build_index.py
│ ├── index
│ │ ├── .managed.json
│ │ ├── .tantivy-meta.lock
│ │ ├── .tantivy-writer.lock
│ │ ├── 06dbe3b0150b4c458eb9dca6bb33d042.fast
│ │ ├── 06dbe3b0150b4c458eb9dca6bb33d042.fieldnorm
│ │ ├── 06dbe3b0150b4c458eb9dca6bb33d042.idx
│ │ ├── 06dbe3b0150b4c458eb9dca6bb33d042.pos
│ │ ├── 06dbe3b0150b4c458eb9dca6bb33d042.store
│ │ ├── 06dbe3b0150b4c458eb9dca6bb33d042.term
│ │ ├── 9bc91a0cf5fe4ad0a9562d1045d1914b.fast
│ │ ├── 9bc91a0cf5fe4ad0a9562d1045d1914b.fieldnorm
│ │ ├── 9bc91a0cf5fe4ad0a9562d1045d1914b.idx
│ │ ├── 9bc91a0cf5fe4ad0a9562d1045d1914b.pos
│ │ ├── 9bc91a0cf5fe4ad0a9562d1045d1914b.store
│ │ ├── 9bc91a0cf5fe4ad0a9562d1045d1914b.term
│ │ ├── cf170ba163f04bf3a5d237ef842a39eb.fast
│ │ ├── cf170ba163f04bf3a5d237ef842a39eb.fieldnorm
│ │ ├── cf170ba163f04bf3a5d237ef842a39eb.idx
│ │ ├── cf170ba163f04bf3a5d237ef842a39eb.pos
│ │ ├── cf170ba163f04bf3a5d237ef842a39eb.store
│ │ ├── cf170ba163f04bf3a5d237ef842a39eb.term
│ │ ├── ffccd63e94df445ab74a5d933334c8ac.fast
│ │ ├── ffccd63e94df445ab74a5d933334c8ac.fieldnorm
│ │ ├── ffccd63e94df445ab74a5d933334c8ac.idx
│ │ ├── ffccd63e94df445ab74a5d933334c8ac.pos
│ │ ├── ffccd63e94df445ab74a5d933334c8ac.store
│ │ ├── ffccd63e94df445ab74a5d933334c8ac.term
│ │ └── meta.json
│ ├── mcp_server.py
│ └── tool-prompt-design.md
└── uv.lock
```
# Files
--------------------------------------------------------------------------------
/src/index/.tantivy-meta.lock:
--------------------------------------------------------------------------------
```
```
--------------------------------------------------------------------------------
/src/index/.tantivy-writer.lock:
--------------------------------------------------------------------------------
```
```
--------------------------------------------------------------------------------
/.python-version:
--------------------------------------------------------------------------------
```
3.13
```
--------------------------------------------------------------------------------
/.dockerignore:
--------------------------------------------------------------------------------
```
# Git
.git
.gitignore
# Python
__pycache__
*.pyc
*.pyo
*.pyd
.Python
*.so
.pytest_cache
.coverage
htmlcov
.tox
.cache
nosetests.xml
coverage.xml
*.cover
*.log
.mypy_cache
.dmypy.json
dmypy.json
# Virtual environments
venv/
.venv/
ENV/
env/
.env
# IDEs
.vscode
.idea
*.swp
*.swo
*~
# OS
.DS_Store
Thumbs.db
# Documentation
*.md
docs/
# Development files
.editorconfig
.pre-commit-config.yaml
# Build artifacts
build/
dist/
*.egg-info/
# Lock files are now needed for uv sync --frozen
# uv.lock
# Docker
.dockerignore
docker-compose*.yml
```
--------------------------------------------------------------------------------
/src/index/.managed.json:
--------------------------------------------------------------------------------
```json
["ffccd63e94df445ab74a5d933334c8ac.pos","06dbe3b0150b4c458eb9dca6bb33d042.pos","ffccd63e94df445ab74a5d933334c8ac.fast","cf170ba163f04bf3a5d237ef842a39eb.term","ffccd63e94df445ab74a5d933334c8ac.term","06dbe3b0150b4c458eb9dca6bb33d042.store","9bc91a0cf5fe4ad0a9562d1045d1914b.fast","9bc91a0cf5fe4ad0a9562d1045d1914b.pos","cf170ba163f04bf3a5d237ef842a39eb.pos","06dbe3b0150b4c458eb9dca6bb33d042.term","cf170ba163f04bf3a5d237ef842a39eb.fast","ffccd63e94df445ab74a5d933334c8ac.idx","meta.json","06dbe3b0150b4c458eb9dca6bb33d042.idx","06dbe3b0150b4c458eb9dca6bb33d042.fieldnorm","cf170ba163f04bf3a5d237ef842a39eb.idx","06dbe3b0150b4c458eb9dca6bb33d042.fast","ffccd63e94df445ab74a5d933334c8ac.fieldnorm","cf170ba163f04bf3a5d237ef842a39eb.fieldnorm","ffccd63e94df445ab74a5d933334c8ac.store","9bc91a0cf5fe4ad0a9562d1045d1914b.store","9bc91a0cf5fe4ad0a9562d1045d1914b.fieldnorm","9bc91a0cf5fe4ad0a9562d1045d1914b.term","cf170ba163f04bf3a5d237ef842a39eb.store","9bc91a0cf5fe4ad0a9562d1045d1914b.idx"]
```
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
```
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[codz]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py.cover
*.lcov
.hypothesis/
.pytest_cache/
.nyc_output
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
#uv.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
#poetry.toml
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
#pdm.lock
#pdm.toml
.pdm-python
.pdm-build/
# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
#pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
# in the .venv directory. It is recommended not to include this directory in version control.
.pixi
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.envrc
.env.development.local
.env.test.local
.env.production.local
.env.local
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/
# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/
# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer,
# you could uncomment the following to ignore the entire vscode folder
.vscode/*
!.vscode/extensions.json
# Sublime Text
*.sublime-workspace
# Ruff stuff:
.ruff_cache/
# PyPI configuration file
.pypirc
# Cursor
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
# refer to https://docs.cursor.com/context/ignore-files
.cursorignore
.cursorindexingignore
# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/
# OS and System Files
# macOS - System files that store metadata, icons, and settings
.DS_Store
.DS_Store?
._*
.AppleDouble
.LSOverride
Icon?
.Spotlight-V100
.Trashes
# Windows - System-generated files and folders
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
ehthumbs_vista.db
[Dd]esktop.ini
$RECYCLE.BIN/
*.lnk
# Linux - System and folder-specific files
.directory
.Trash-*
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Additional logs
logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Cache directories
.parcel-cache
```
--------------------------------------------------------------------------------
/.github/workflows/README.md:
--------------------------------------------------------------------------------
```markdown
# Workflow Architecture
> Updated on 2025-07-21 by @KemingHe
Modular automation for weekly Python dependency manager documentation updates.
## 🏗️ Current System
```mermaid
graph LR
CRON_TRIGGER["⏰ Tuesday 6pm ET<br/>Cron Trigger"]
ORCHESTRATOR["🎯 Orchestrator<br/>auto-update.yml"]
UPDATE_DOCS["📚 Documentation Sync<br/>auto-update-docs.yml"]
UPDATE_INDEX["🔍 Search Index<br/>auto-update-index.yml"]
PUBLISH["🐳 Publish Image<br/>auto-update-publish.yml"]
CRON_TRIGGER --> ORCHESTRATOR
ORCHESTRATOR --> UPDATE_DOCS
UPDATE_DOCS --> UPDATE_INDEX
UPDATE_INDEX --> PUBLISH
```
**Security**: Pinned 3rd-party actions, signed commits, modular execution, [CodeQL analysis](README-codeql.md)
## 🚀 Planned Extensions
- **Managers**: pipenv, pdm, pixi
- **Features**: Conditional updates, performance monitoring
## 🔧 Operations
- **Testing**: `workflow_dispatch` on `update-docs`, `update-index`, and `publish`
- **Monitoring**: Check Tuesday runs for upstream changes
```
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
```markdown
# Python Dependency Manager Companion MCP Server
> README updated on 2025-08-16 by [@KemingHe](https://github.com/KemingHe)
Stop getting out-of-date Python package manager commands from your AI. Cross-reference latest official [`pip`](https://pip.pypa.io/), [`conda`](https://docs.conda.io/projects/conda), [`poetry`](https://python-poetry.org/), [`uv`](https://docs.astral.sh/uv/), [`pixi`](https://pixi.sh/), and [`pdm`](https://pdm-project.org/) docs with auto-updates. [[Watch Demo on YouTube]](https://youtu.be/3nVp46Q8FdY)
## 🚀 Quick Start for Agentic IDEs
**1. Pull Docker image**:
```shell
# Pin to commit hash for production security
# Get current hash from: https://hub.docker.com/r/keminghe/py-dep-man-companion/tags
docker pull keminghe/py-dep-man-companion@sha256:2c896dc617e8cd3b1a1956580322b0f0c80d5b6dfd09743d90859d2ef2b71ec6 # 2025-07-22 release example
# Or use latest for development
docker pull keminghe/py-dep-man-companion:latest
```
**2. Add to your IDE's `mcp.json`**:
```json
{
"mcp": {
"servers": {
"python-deps": {
"command": "docker",
"args": ["run", "-i", "--rm", "keminghe/py-dep-man-companion"]
}
}
}
}
```
**3. Ask package manager questions** - "How to migrate a `conda` project to `uv`?" and get accurate, current official syntax.
## 🤝 Contributing
**Use as template**: [[Create from template]](https://github.com/new?template_name=python-dependency-manager-companion-mcp-server&template_owner=KemingHe) for your own MCP server projects.
**Contribute back**: Fork and follow [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup.
## 🔄 Auto-Update Architecture
1. ⏰ **Every Tuesday 6pm ET**
2. 📚 **Sync Official Docs**
3. 🔍 **Rebuild Search Index**
4. 🐳 **Publish Latest Image**
## 🗺️ Roadmap
- [x] Added support for `pixi` and `pdm` in version 0.1.1
- [ ] Add comprehensive tests with 100% coverage
- [ ] Add indexing support for PDF and CSV files
## 📁 Project Structure
```plaintext
python-dependency-manager-companion-mcp-server/
├── .github/workflows/ # Automation workflows
│ ├── auto-update-docs.yml # Weekly docs update
│ ├── auto-update-index.yml # Search index rebuild
│ ├── auto-update-publish.yml # Multi-arch Docker publish
│ ├── auto-update.yml # Combined automation
│ └── README.md # Workflow documentation
├── src/
│ ├── assets/ # Documentation source files
│ │ ├── conda/ # conda docs
│ │ ├── pip/ # pip docs
│ │ ├── poetry/ # poetry docs
│ │ ├── uv/ # uv docs
│ │ ├── pixi/ # pixi docs
│ │ └── pdm/ # pdm docs
│ ├── index/ # Pre-built search index
│ ├── build_index.py # Tantivy index builder
│ └── mcp_server.py # FastMCP stdio server
├── Dockerfile # Container build configuration
├── pyproject.toml # Project dependencies and metadata
└── uv.lock # Locked dependencies
```
## 📄 License
This project is licensed under the [MIT License](./LICENSE) - a permissive license that allows free use, modification, and distribution with attribution.
## 📞 Support
Open a [GitHub issue](https://github.com/KemingHe/python-dependency-manager-companion-mcp-server/issues) for bug reports and feature requests.
```
--------------------------------------------------------------------------------
/src/assets/pdm/dev/contributing.md:
--------------------------------------------------------------------------------
```markdown
--8<-- "CONTRIBUTING.md"
```
--------------------------------------------------------------------------------
/src/assets/conda/source/dev-guide/contributing.md:
--------------------------------------------------------------------------------
```markdown
```{include} ../../../CONTRIBUTING.md
```
[development-environment]: development-environment
```
--------------------------------------------------------------------------------
/src/assets/uv/reference/policies/license.md:
--------------------------------------------------------------------------------
```markdown
# License
uv is licensed under either of
- Apache License, Version 2.0
[LICENSE-APACHE](https://github.com/astral-sh/uv/blob/main/LICENSE-APACHE) or
<https://www.apache.org/licenses/LICENSE-2.0>
- MIT License
[LICENSE-MIT](https://github.com/astral-sh/uv/blob/main/LICENSE-MIT) or
<https://opensource.org/licenses/MIT>
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in uv
by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any
additional terms or conditions.
```
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
```markdown
# Contributing to Python Dependency Manager MCP Server
> Updated on 2025-07-23 by @KemingHe
Thank you for your interest in contributing! This guide covers development workflow and setup.
## 🔄 Contribution Workflow
> [!IMPORTANT]
> **Issue-first approach**: No issue, no PR. No PR, no merge.
1. **Raise issue** - Bug report or feature request
2. **Get assigned** - Wait for maintainer assignment
3. **Create PR** - Link to assigned issue
4. **Review & approval** - Address feedback
5. **Merge** - Maintainer merges approved PR
## 🛠️ Development Setup
### Local Development
```shell
# Clone and setup
git clone <repo-url>
cd python-dep-manager-companion-mcp-server
uv sync
# Run server locally
uv run --with fastmcp --with tantivy fastmcp run src/mcp_server.py
# Build Docker image
docker build -t py-dep-man-companion .
```
### Local Testing
Add to your VSCode/Cursor's `mcp.json` for testing:
> [!IMPORTANT]
> Replace `/path/to/your/repo` with **absolute path** to your local repository.
```json
{
"mcp": {
"servers": {
"py-dep-man-companion-development": {
"command": "uv",
"args": [
"run", "--directory", "/path/to/your/repo",
"--with", "fastmcp>=2.10.5", "--with", "tantivy>=0.24.0",
"fastmcp", "run", "src/mcp_server.py"
]
}
}
}
}
```
## 📝 Development Standards
### Git Workflow
- **Branching**: `type/feature-or-bug-scope/GitHubUsername`
- **Types**: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`
- **Commits**: Use `prompts/prompt-commit-msg-gen.md` for consistency
### Quality Tools
Available templates and prompts for consistent contributions:
> [!TIP]
> Use these tools for consistent, high-quality contributions that reduce review cycles.
```plaintext
.github/
├── ISSUE_TEMPLATE/
│ ├── bug-report.md # Bug report template
│ └── feature-request.md # Feature request template
└── pull_request_template.md
prompts/
├── prompt-commit-msg-gen.md # Generate uniform commit messages
├── prompt-issue-gen.md # Create well-structured issues
├── prompt-pull-request-gen.md # Write comprehensive PR descriptions
└── prompt-readme-gen.md # Maintain documentation standards
```
## 🤖 Automated Systems
The repository auto-updates weekly (Tuesday 06:00pm ET):
1. Syncs official documentation
2. Rebuilds search indexes
3. Publishes Docker images
See [.github/workflows/README.md](.github/workflows/README.md) for technical details.
```
--------------------------------------------------------------------------------
/src/assets/poetry/contributing.md:
--------------------------------------------------------------------------------
```markdown
---
title: "Contributing to Poetry"
draft: false
type: docs
layout: single
menu:
docs:
weight: 100
note: "Are you viewing this document on GitHub? For the best experience, view it on the website https://python-poetry.org/docs/contributing."
---
# Contributing to Poetry
First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to Poetry on GitHub. These are mostly guidelines, not rules. Use
your best judgement, and feel free to propose changes to this document in a pull request.
## How to contribute
### Reporting bugs
This section guides you through submitting a bug report for Poetry.
Following these guidelines helps maintainers and the community understands your report, reproduces the behavior, and finds
related reports.
#### Before submitting a bug report
* **Check the [FAQ]** for a list of common questions and problems.
* **Check the [blog]** for release notes from recent releases, including steps for upgrading and known issues.
* **Check that your issue does not already exist** in the [issue tracker].
* **Make sure your issue is really a bug, and is not a support request or question** better suited for [Discussions]
or [Discord].
* **Try running your commands with the** `--no-cache` **flag**.
* **Try clearing your cache with** `poetry cache clear --all PyPI` **and rerunning your commands**.
{{% note %}}
If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and
include a link to the original issue in the body of your new one.
{{% /note %}}
#### How do I submit a bug report?
Bugs concerning Poetry and poetry-core should be submitted to the main [issue tracker], using the correct
[issue template].
Explain the problem and make it easy for others to search for and understand:
* **Use a clear and descriptive title** for the issue to identify the problem.
* **Describe the exact steps which reproduce the problem** in as many details as possible.
* **Describe the behavior you observed after following the steps** and point out how this is a bug.
* **Explain which behavior you expected to see instead and why.**
* **If the problem involves an unexpected error being raised**, execute the problematic command in **debug** mode
(with `-vvv` flag).
Provide detailed steps for reproduction of your issue:
* **Provide your pyproject.toml file** in a [Gist](https://gist.github.com), pastebin, or example repository after
removing potential private information like private package repositories or names.
* **Provide specific examples to demonstrate the steps to reproduce the issue**. This could be an example repository, a
sequence of steps run in a container, or just a pyproject.toml for very simple cases.
* **Are you unable to reliably reproduce the issue?** If so, provide details about how often the problem happens
and under which conditions it normally happens.
Provide more context by answering these questions:
* **Did the problem start happening recently** (e.g., after updating to a new version of Poetry) or was this always a
problem?
* If the problem started happening recently, **can you reproduce the problem in an older version of Poetry?** What's the
most recent version in which the problem does not happen?
* **Is there anything exotic or unusual about your environment?** This could include use of special container images,
newer CPU architectures like Apple Silicon, or corporate proxies that intercept or modify your network traffic.
Include details about your configuration and environment:
* **Which version of Poetry are you using?** You can get the exact version by running `poetry --version`.
* **What version of Python is being used to run Poetry?** Execute the `poetry debug info` to get this information.
* **What's the name and version of the OS you're using?** Examples include Ubuntu 22.04 or macOS 12.6.
To give others the best chance to understand and reproduce your issue, please be sure to put extra effort into your
reproduction steps. You can both rule out local configuration issues on your end, and ensure others can cleanly
reproduce your issue if attempt all reproductions in a pristine container (or VM), and provide the steps you performed
inside that container/VM in your issue report.
### Suggesting enhancements
This section guides you through submitting an enhancement suggestion for Poetry, including completely new features as
well as improvements to existing functionality. Following these guidelines helps maintainers and the community
understand your suggestion and find related suggestions.
#### Before submitting a suggested enhancement
* **Check the [FAQ]** for a list of common questions and problems.
* **Check that your issue does not already exist** in the [issue tracker].
#### How do I submit a suggested enhancement?
Suggested enhancements concerning Poetry and poetry-core should be submitted to the main [issue tracker], using the
correct [issue template].
* **Use a clear and descriptive title** for the issue to identify the suggestion.
* **Provide a detailed description of the proposed enhancement**, with specific steps or examples when possible.
* **Describe the current behavior** and **explain which behavior you would like to see instead**, and why.
### Documentation contributions
One of the simplest ways to get started contributing to a project is through improving documentation. Poetry is
constantly evolving, and this means that sometimes our documentation has gaps. You can help by adding missing sections,
editing the existing content to be more accessible, or creating new content such as tutorials, FAQs, etc.
{{% note %}}
GitHub [Discussions](https://github.com/python-poetry/poetry/discussions) and the
[kind/question label](https://github.com/python-poetry/poetry/labels/kind/question) are excellent sources for FAQ
candidates.
{{% /note %}}
Issues pertaining to the documentation are usually marked with the [area/docs label], which will also trigger a preview
of the changes as rendered by this website.
### Code contributions
#### Picking an issue
{{% note %}}
If you are a first time contributor, and are looking for an issue to take on, you might want to look for
at the [contributing page](https://github.com/python-poetry/poetry/contribute) for candidates. We do our best to curate
good issues for first-time contributors there, but do fall behind -- so if you don't see anything good, feel free to
ask.
{{% /note %}}
If you would like to take on an issue, feel free to comment on the issue tagging `@python-poetry/triage`.
We are more than happy to discuss solutions on the issue. If you would like help with navigating the code base, are
looking for something to work on, or want feedback on a design or change, join us on our [Discord server][Discord] or
start a [Discussion][Discussions].
#### Local development
Poetry is developed using Poetry. Refer to the [documentation] to install Poetry in your local environment.
{{% note %}}
Poetry's development toolchain requires Python 3.9 or newer.
{{% /note %}}
You should first fork the Poetry repository and then clone it locally, so that you can make pull requests against the
project. If you are new to Git and pull request-based development, GitHub provides a
[guide](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) you will find helpful.
Next, you should install Poetry's dependencies, and run the test suite to make sure everything is working as expected:
```bash
poetry install
poetry run pytest
```
{{% note %}}
If you want to see the coverage stats after the tests are complete, use:
```bash
poetry run pytest --cov=src/poetry --cov-report term
```
{{% /note %}}
When you contribute to Poetry, automated tools will be run to make sure your code is suitable to be merged. Besides
pytest, you will need to make sure your code typechecks properly using [mypy](http://mypy-lang.org/):
```bash
poetry run mypy
```
Finally, a great deal of linting tools are run on your code, to try and ensure consistent code style and root out common
mistakes. The [pre-commit](https://pre-commit.com/) tool is used to install and run these tools, and requires one-time
setup:
```bash
poetry run pre-commit install
```
pre-commit will now run and check your code every time you make a commit. By default, it will only run on changed files,
but you can run it on all files manually (this may be useful if you altered the pre-commit config):
```bash
poetry run pre-commit run --all-files
```
#### Pull requests
* Fill out the pull request body completely and describe your changes as accurately as possible. The pull request body
should be kept up to date as it will usually form the base for the final merge commit and the changelog entry.
* Be sure that your pull request contains tests that cover the changed or added code. Tests are generally required for
code be to be considered mergeable, and code without passing tests will not be merged.
* Ensure your pull request passes the mypy and pre-commit checks. Remember that you can run these tools locally
instead of relying on remote CI.
* If your changes warrant a documentation change, the pull request must also update the documentation. Make sure to
review the documentation preview generated by CI for any rendering issues.
{{% note %}}
Make sure your branch is [rebased](https://docs.github.com/en/get-started/using-git/about-git-rebase) against the latest
base branch. A maintainer might ask you to ensure the branch is up-to-date prior to merging your pull request
(especially if there have been CI changes on the base branch), and will also ask you to fix any conflicts.
{{% /note %}}
All pull requests, unless otherwise instructed, need to be first accepted into the `main` branch. Maintainers will
generally decide if any backports to other branches are required, and carry them out as needed.
### Issue triage
{{% note %}}
If you have an issue that hasn't had any attention, you can ping us `@python-poetry/triage` on the issue. Please give us
reasonable time to get to your issue first, and avoid pinging any individuals directly, especially if they are not part
of the Poetry team.
{{% /note %}}
If you are helping with the triage of reported issues, this section provides some useful information to assist you in
your contribution.
#### Triage steps
1. Determine what area and versions of Poetry the issue is related to, and set the appropriate labels (e.g.
`version/x.x.x`, `area/docs`, `area/venv`), and remove the `status/triage` label.
2. If requested information (such as debug logs, pyproject.toml, etc.) is not provided and is relevant, request it from
the author.
1. Set the `status/waiting-on-response` label while waiting to hear back from the author.
3. Attempt to reproduce the issue with the reported Poetry version or request further clarification from the author.
4. Ensure the issue is not already resolved. Try reproducing it on the latest stable release, the latest prerelease (if
present), and the development branch.
5. If the issue cannot be reproduced,
1. request more reproduction steps and clarification from the issue's author,
2. set the `status/needs-reproduction` label,
3. close the issue if there is no reproduction forthcoming.
6. If the issue can be reproduced,
1. comment on the issue confirming so,
2. set the `status/confirmed` label,
3. if possible, identify the root cause of the issue,
4. if interested, attempt to fix it via a pull request.
#### Multiple versions
When trying to reproduce issues, you often want to use multiple versions of Poetry at the same time.
[pipx](https://pypa.github.io/pipx/) makes this easy to do:
```sh
pipx install --suffix @1.2.1 'poetry==1.2.1'
pipx install --suffix @1.3.0rc1 'poetry==1.3.0rc1'
pipx install --suffix @main 'poetry @ git+https://github.com/python-poetry/poetry'
pipx install --suffix @local '/path/to/local/clone/of/poetry'
# now you can use any of the chosen versions of Poetry with their configured suffix, e.g.
poetry@main --version
```
{{% note %}}
Do not forget to `pipx upgrade poetry@main` before using it, to make sure you have the latest changes.
{{% /note %}}
{{% note %}}
This mechanism can also be used to test pull requests by using GitHub's pull request remote refs:
```sh
pipx install --suffix @pr1234 git+https://github.com/python-poetry/poetry.git@refs/pull/1234/head
```
{{% /note %}}
[Blog]: {{< ref "/blog" >}}
[Documentation]: {{< ref "/docs" >}}
[FAQ]: {{< relref "faq" >}}
[Issue Tracker]: https://github.com/python-poetry/poetry/issues
[area/docs label]: https://github.com/python-poetry/poetry/labels/area/docs
[kind/question label]: https://github.com/python-poetry/poetry/labels/kind/question
[Issue Template]: https://github.com/python-poetry/poetry/issues/new/choose
[Discussions]: https://github.com/python-poetry/poetry/discussions
[Discord]: https://discord.com/invite/awxPgve
```
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
```yaml
blank_issues_enabled: false
```
--------------------------------------------------------------------------------
/src/assets/uv/reference/policies/index.md:
--------------------------------------------------------------------------------
```markdown
# Policies
- [Versioning](./versioning.md)
- [Platform support](./platforms.md)
- [License](./license.md)
```
--------------------------------------------------------------------------------
/src/assets/uv/reference/internals/index.md:
--------------------------------------------------------------------------------
```markdown
# Internals
The internals section provides details about uv's internal components and implementation details.
- [Resolver](./resolver.md)
```
--------------------------------------------------------------------------------
/src/assets/pdm/dev/changelog.md:
--------------------------------------------------------------------------------
```markdown
# Changelog
!!! warning "Attention"
Major and minor releases also include changes listed within prior beta releases.
--8<-- "CHANGELOG.md"
```
--------------------------------------------------------------------------------
/src/assets/pip/_metadata.json:
--------------------------------------------------------------------------------
```json
{
"source_repo": "pypa/pip",
"docs_path": "docs",
"updated_at": "2026-01-06T22:05:23Z",
"commit_sha": "6e8e00c178a7f02ef1936125142b72bc820147ae"
}
```
--------------------------------------------------------------------------------
/src/assets/conda/_metadata.json:
--------------------------------------------------------------------------------
```json
{
"source_repo": "conda/conda",
"docs_path": "docs",
"updated_at": "2026-01-06T22:05:35Z",
"commit_sha": "08883691db68b615b2d3baab33becd7f490588ee"
}
```
--------------------------------------------------------------------------------
/src/assets/pdm/dev/fixtures.md:
--------------------------------------------------------------------------------
```markdown
# Pytest fixtures
::: pdm.pytest
options:
show_source: false
show_root_heading: false
show_root_toc_entry: false
heading_level: 2
```
--------------------------------------------------------------------------------
/src/assets/uv/_metadata.json:
--------------------------------------------------------------------------------
```json
{
"source_repo": "astral-sh/uv",
"docs_path": "docs",
"updated_at": "2026-01-06T22:05:56Z",
"commit_sha": "cd55d1ce120f3c4dfe37a9df563e97e25914e1ba"
}
```
--------------------------------------------------------------------------------
/src/assets/pdm/_metadata.json:
--------------------------------------------------------------------------------
```json
{
"source_repo": "pdm-project/pdm",
"docs_path": "docs",
"updated_at": "2026-01-06T22:06:18Z",
"commit_sha": "a0c6090184ab11e040236836d0ffe97337cd374b"
}
```
--------------------------------------------------------------------------------
/src/assets/pixi/_metadata.json:
--------------------------------------------------------------------------------
```json
{
"source_repo": "prefix-dev/pixi",
"docs_path": "docs",
"updated_at": "2026-01-06T22:06:08Z",
"commit_sha": "4b970bd8dca5c0369c785623a97a5a95fa242bd0"
}
```
--------------------------------------------------------------------------------
/src/assets/poetry/_metadata.json:
--------------------------------------------------------------------------------
```json
{
"source_repo": "python-poetry/poetry",
"docs_path": "docs",
"updated_at": "2026-01-06T22:05:44Z",
"commit_sha": "cc1d791d402b9c6430b9791af7609d491f4be04f"
}
```
--------------------------------------------------------------------------------
/src/assets/conda/source/release-notes.md:
--------------------------------------------------------------------------------
```markdown
# Release notes
This information is drawn from the GitHub conda project
changelog: https://github.com/conda/conda/blob/main/CHANGELOG.md
```{include} ../../CHANGELOG.md
```
```
--------------------------------------------------------------------------------
/src/assets/conda/source/dev-guide/deep-dives/index.md:
--------------------------------------------------------------------------------
```markdown
# Deep dives
This section contains a series of deep dives into particularly complex parts
of conda.
```{toctree}
---
maxdepth: 1
---
install
activation
context
condarc
solvers
logging
```
```
--------------------------------------------------------------------------------
/src/assets/pdm/dev/benchmark.md:
--------------------------------------------------------------------------------
```markdown
# Benchmark
This page has been removed, please visit [Python Package Manager Shootout by Lincoln Loop](https://lincolnloop.github.io/python-package-manager-shootout/) for a detailed benchmark report.
```
--------------------------------------------------------------------------------
/src/assets/conda/source/dev-guide/specs/index.md:
--------------------------------------------------------------------------------
```markdown
# Specifications
This section contains an incomplete list of conda specifications that
may or may not be related to [Conda Enhancement Proposals](https://github.com/conda-incubator/ceps).
```{toctree}
---
maxdepth: 1
---
solver-state
```
```
--------------------------------------------------------------------------------
/src/assets/pip/html/reference/index.md:
--------------------------------------------------------------------------------
```markdown
# Reference
Reference provides information about various file formats, interfaces and
interoperability standards that pip utilises/implements.
```{toctree}
:titlesonly:
build-system
requirement-specifiers
requirements-file-format
installation-report
inspect-report
```
```
--------------------------------------------------------------------------------
/src/assets/pdm/reference/api.md:
--------------------------------------------------------------------------------
```markdown
# API Reference
::: pdm.core.Core
options:
show_root_heading: yes
show_source: false
heading_level: 2
::: pdm.core.Project
options:
show_root_heading: yes
show_source: false
heading_level: 2
## Signals
+++ 1.12.0
::: pdm.signals
options:
heading_level: 3
```
--------------------------------------------------------------------------------
/src/assets/uv/reference/troubleshooting/index.md:
--------------------------------------------------------------------------------
```markdown
# Troubleshooting
The troubleshooting section provides information about investigating failures in uv:
- [Build failures](./build-failures.md): Understanding common causes of package build failures.
- [Reproducible examples](./reproducible-examples.md): How to write a minimal reproducible example
for a uv issue.
```
--------------------------------------------------------------------------------
/src/assets/uv/reference/benchmarks.md:
--------------------------------------------------------------------------------
```markdown
# Benchmarks
uv's performance is continually benchmarked against previous releases, and regularly compared to
other tools in the space, like pip and Poetry.
The latest benchmarks and details on the benchmarking process can be found in the
[GitHub repository](https://github.com/astral-sh/uv/blob/main/BENCHMARKS.md).
```
--------------------------------------------------------------------------------
/src/assets/uv/concepts/authentication/index.md:
--------------------------------------------------------------------------------
```markdown
# Authentication
Authentication is required when working with private repositories or package indexes.
Learn more about authentication in uv:
- [Using the `uv auth` CLI](./cli.md)
- [HTTP authentication](./http.md)
- [Git authentication](./git.md)
- [TLS certificates](./certificates.md)
- [Third-party services](./third-party.md)
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/name/get.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace name get
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [name](../name.md) get
Get the workspace name
--8<-- "docs/reference/cli/pixi/workspace/name/get_extender:description"
## Usage
```
pixi workspace name get
```
--8<-- "docs/reference/cli/pixi/workspace/name/get_extender:example"
```
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature-request.md:
--------------------------------------------------------------------------------
```markdown
---
name: Feature request
about: Suggest a new feature or enhancement
title: '✨ feat(component): brief description'
labels: 'enhancement, help wanted'
---
### 🎯 Problem
[Description of the problem or limitation this addresses]
### 💡 Proposed Solution
[Description of the desired feature or enhancement]
### 🤔 Alternatives Considered
[Other approaches considered, if any] (optional)
```
--------------------------------------------------------------------------------
/src/assets/pixi/integration/extensions/pixi_inject.md:
--------------------------------------------------------------------------------
```markdown
[pixi-inject](https://github.com/pavelzw/pixi-inject) is a simple executable that injects a conda package into an existing pixi environment.
```
pixi inject --environment default --package my-package-0.1.0-py313h8aa417a_0.conda
```
You can also specify a custom conda prefix to inject the package into.
```
pixi inject --prefix /path/to/conda/env --package my-package-0.1.0-py313h8aa417a_0.conda
```
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/version/get.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace version get
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [version](../version.md) get
Get the workspace version
--8<-- "docs/reference/cli/pixi/workspace/version/get_extender:description"
## Usage
```
pixi workspace version get
```
--8<-- "docs/reference/cli/pixi/workspace/version/get_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pip/html/topics/index.md:
--------------------------------------------------------------------------------
```markdown
# Topic Guides
These pages provide detailed information on individual topics.
```{note}
This section of the documentation is currently being fleshed out. See
{issue}`9475` for more details.
```
```{toctree}
:maxdepth: 1
authentication
caching
configuration
dependency-resolution
more-dependency-resolution
https-certificates
local-project-installs
repeatable-installs
secure-installs
vcs-support
python-option
workflow
```
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/feature/list.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace feature list
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [feature](../feature.md) list
List the features in the manifest file
--8<-- "docs/reference/cli/pixi/workspace/feature/list_extender:description"
## Usage
```
pixi workspace feature list
```
--8<-- "docs/reference/cli/pixi/workspace/feature/list_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/version/major.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace version major
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [version](../version.md) major
Bump the workspace version to MAJOR
--8<-- "docs/reference/cli/pixi/workspace/version/major_extender:description"
## Usage
```
pixi workspace version major
```
--8<-- "docs/reference/cli/pixi/workspace/version/major_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/version/minor.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace version minor
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [version](../version.md) minor
Bump the workspace version to MINOR
--8<-- "docs/reference/cli/pixi/workspace/version/minor_extender:description"
## Usage
```
pixi workspace version minor
```
--8<-- "docs/reference/cli/pixi/workspace/version/minor_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/version/patch.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace version patch
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [version](../version.md) patch
Bump the workspace version to PATCH
--8<-- "docs/reference/cli/pixi/workspace/version/patch_extender:description"
## Usage
```
pixi workspace version patch
```
--8<-- "docs/reference/cli/pixi/workspace/version/patch_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/platform/list.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace platform list
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [platform](../platform.md) list
List the platforms in the workspace file
--8<-- "docs/reference/cli/pixi/workspace/platform/list_extender:description"
## Usage
```
pixi workspace platform list
```
--8<-- "docs/reference/cli/pixi/workspace/platform/list_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/guides/migration/index.md:
--------------------------------------------------------------------------------
```markdown
# Migration guides
Learn how to migrate from other tools to uv:
- [Migrate from pip to uv projects](./pip-to-project.md)
!!! note
Other guides, such as migrating from another project management tool, or from pip to `uv pip`
are not yet available. See [#5200](https://github.com/astral-sh/uv/issues/5200) to track
progress.
Or, explore the [integration guides](../integration/index.md) to learn how to use uv with other
software.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/environment/list.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace environment list
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [environment](../environment.md) list
List the environments in the manifest file
--8<-- "docs/reference/cli/pixi/workspace/environment/list_extender:description"
## Usage
```
pixi workspace environment list
```
--8<-- "docs/reference/cli/pixi/workspace/environment/list_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/requires-pixi/get.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace requires-pixi get
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [requires-pixi](../requires-pixi.md) get
Get the pixi minimum version requirement
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/get_extender:description"
## Usage
```
pixi workspace requires-pixi get
```
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/get_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/requires-pixi/unset.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace requires-pixi unset
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [requires-pixi](../requires-pixi.md) unset
Remove the pixi minimum version requirement
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/unset_extender:description"
## Usage
```
pixi workspace requires-pixi unset
```
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/unset_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/requires-pixi/verify.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace requires-pixi verify
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [requires-pixi](../requires-pixi.md) verify
Verify the pixi minimum version requirement
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/verify_extender:description"
## Usage
```
pixi workspace requires-pixi verify
```
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/verify_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/auth/logout.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi auth logout
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [auth](../auth.md) logout
Remove authentication information for a given host
--8<-- "docs/reference/cli/pixi/auth/logout_extender:description"
## Usage
```
pixi auth logout <HOST>
```
## Arguments
- <a id="arg-<HOST>" href="#arg-<HOST>">`<HOST>`</a>
: The host to remove authentication for
<br>**required**: `true`
--8<-- "docs/reference/cli/pixi/auth/logout_extender:example"
```
--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
```markdown
---
name: Pull Request
about: Submit a pull request for review
title: '🔄 type(scope): brief description'
---
[Brief description of changes and purpose]
Closes #[issue-number]
> [!WARNING]
>
> [Any merge requirements or dependencies]
### 🎯 Key Features
- **[Feature name]**: [Description of functionality or change]
### 💼 Business Impact
- **[Impact area]**: [How this benefits users or business]
### 🔧 Technical Highlights
- **[Technical aspect]**: [Implementation details or improvements]
---
```
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug-report.md:
--------------------------------------------------------------------------------
```markdown
---
name: Bug report
about: Submit a bug report to notify our team
title: '🐛 bug(component): brief description'
labels: 'bug, help wanted'
---
### 🐛 What happened?
**Expected**: [What should happen]
**Actual**: [What actually happened]
### 🔄 Steps to Reproduce
1. [First step to reproduce]
2. [Second step to reproduce]
3. [Third step where error occurs]
Walkthrough recording: [Loom link or video]
### 🌍 Environment
- OS: [e.g. macOS 14.0]
- Browser: [e.g. Chrome 120] (if applicable)
- Version: [e.g. v1.0.0]
```
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
```toml
[project]
name = "py_dep_man_companion"
version = "0.1.1"
description = "Local stdio MCP server providing unified search across Python dependency managers' latest and official documentation."
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.13"
urls.repository = "https://github.com/KemingHe/python-dependency-manager-companion-mcp-server"
urls.issues = "https://github.com/KemingHe/python-dependency-manager-companion-mcp-server/issues"
dependencies = [
"fastmcp>=2.10.5",
"tantivy>=0.24.0",
]
```
--------------------------------------------------------------------------------
/src/assets/uv/getting-started/first-steps.md:
--------------------------------------------------------------------------------
```markdown
# First steps with uv
After [installing uv](./installation.md), you can check that uv is available by running the `uv`
command:
```console
$ uv
An extremely fast Python package manager.
Usage: uv [OPTIONS] <COMMAND>
...
```
You should see a help menu listing the available commands.
## Next steps
Now that you've confirmed uv is installed, check out an [overview of features](./features.md), learn
how to [get help](./help.md) if you run into any problems, or jump to the
[guides](../guides/index.md) to start using uv.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/description/get.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace description get
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [description](../description.md) get
Get the workspace description
--8<-- "docs/reference/cli/pixi/workspace/description/get_extender:description"
## Usage
```
pixi workspace description get
```
## Description
Get the workspace description.
Example: `pixi workspace description get`
--8<-- "docs/reference/cli/pixi/workspace/description/get_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/concepts/index.md:
--------------------------------------------------------------------------------
```markdown
# Concepts overview
Read the concept documents to learn more about uv's features:
- [Projects](./projects/index.md)
- [Tools](./tools.md)
- [Python versions](./python-versions.md)
- [Configuration files](./configuration-files.md)
- [Package indexes](./indexes.md)
- [Resolution](./resolution.md)
- [The uv build backend](./build-backend.md)
- [Authentication](./authentication/index.md)
- [Caching](./cache.md)
- [The pip interface](../pip/index.md)
Looking for a quick introduction to features? See the [guides](../guides/index.md) instead.
```
--------------------------------------------------------------------------------
/src/assets/uv/getting-started/index.md:
--------------------------------------------------------------------------------
```markdown
# Getting started
To help you get started with uv, we'll cover a few important topics:
- [Installing uv](./installation.md)
- [First steps after installation](./first-steps.md)
- [An overview of uv's features](./features.md)
- [How to get help](./help.md)
Read on, or jump ahead to another section:
- Get going quickly with [guides](../guides/index.md) for common workflows.
- Learn more about the core [concepts](../concepts/index.md) in uv.
- Use the [reference](../reference/index.md) documentation to find details about something specific.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/channel/list.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace channel list
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [channel](../channel.md) list
List the channels in the manifest
--8<-- "docs/reference/cli/pixi/workspace/channel/list_extender:description"
## Usage
```
pixi workspace channel list [OPTIONS]
```
## Options
- <a id="arg---urls" href="#arg---urls">`--urls`</a>
: Whether to display the channel's names or urls
--8<-- "docs/reference/cli/pixi/workspace/channel/list_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/version/set.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace version set
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [version](../version.md) set
Set the workspace version
--8<-- "docs/reference/cli/pixi/workspace/version/set_extender:description"
## Usage
```
pixi workspace version set <VERSION>
```
## Arguments
- <a id="arg-<VERSION>" href="#arg-<VERSION>">`<VERSION>`</a>
: The new workspace version
<br>**required**: `true`
--8<-- "docs/reference/cli/pixi/workspace/version/set_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/__README.md:
--------------------------------------------------------------------------------
```markdown
This directory contains the same structure as the autogenerated cli documentation.
In all the autogenerated files, there are `snippets` injected like `description` and `example`.
If you put a file with the same file name and path as the autogenerated companion file, the `snippets` will be injected into the file.
For example, `docs/autogenerated/pixi.md` is the autogenerated file and `docs/reference/cli/pixi.md` is the injecting file.
Snipped documentation can be found here: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
```
--------------------------------------------------------------------------------
/src/assets/uv/guides/index.md:
--------------------------------------------------------------------------------
```markdown
# Guides overview
Check out one of the core guides to get started:
- [Installing Python versions](./install-python.md)
- [Running scripts and declaring dependencies](./scripts.md)
- [Running and installing applications as tools](./tools.md)
- [Creating and working on projects](./projects.md)
- [Building and publishing packages](./package.md)
- [Integrate uv with other software, e.g., Docker, GitHub, PyTorch, and more](./integration/index.md)
Or, explore the [concept documentation](../concepts/index.md) for comprehensive breakdown of each
feature.
```
--------------------------------------------------------------------------------
/src/assets/pip/html/ux-research-design/index.md:
--------------------------------------------------------------------------------
```markdown
# UX Research & Design
```{toctree}
:hidden:
contribute
guidance
research-results/index
```
Welcome to pip’s UX research and design documentation. The purpose of this section of the documentation is to:
- [Identify where new contributors can participate in or lead UX research and design activities](contribute)
- [Share pip UX guidelines](guidance), including an introduction to User Centered Design practices, and how they can be applied to the pip project
- Share [results of user research](research-results/index) that the pip team has already conducted
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/auth.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi auth
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) auth
Login to prefix.dev or anaconda.org servers to access private channels
--8<-- "docs/reference/cli/pixi/auth_extender:description"
## Usage
```
pixi auth <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`login`](auth/login.md) | Store authentication information for a given host |
| [`logout`](auth/logout.md) | Remove authentication information for a given host |
--8<-- "docs/reference/cli/pixi/auth_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/completion.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi completion
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) completion
Generates a completion script for a shell
--8<-- "docs/reference/cli/pixi/completion_extender:description"
## Usage
```
pixi completion --shell <SHELL>
```
## Options
- <a id="arg---shell" href="#arg---shell">`--shell (-s) <SHELL>`</a>
: The shell to generate a completion script for
<br>**required**: `true`
<br>**options**: `bash`, `elvish`, `fish`, `nushell`, `powershell`, `zsh`
--8<-- "docs/reference/cli/pixi/completion_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/reference/index.md:
--------------------------------------------------------------------------------
```markdown
# Reference
The reference section provides information about specific parts of uv:
- [Commands](./cli.md): A reference for uv's command line interface.
- [Settings](./settings.md): A reference for uv's configuration schema.
- [Resolver](./internals/resolver.md): Details about the internals of uv's resolver.
- [Storage](./storage.md): Information about where uv stores data on your system.
- [Policies](./policies/index.md): uv's versioning policy, platform support policy, and license.
Looking for a broader overview? Check out the [concepts](../concepts/index.md) documentation.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/feature/remove.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace feature remove
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [feature](../feature.md) remove
Remove a feature from the manifest file
--8<-- "docs/reference/cli/pixi/workspace/feature/remove_extender:description"
## Usage
```
pixi workspace feature remove <FEATURE>
```
## Arguments
- <a id="arg-<FEATURE>" href="#arg-<FEATURE>">`<FEATURE>`</a>
: The name of the feature to remove
<br>**required**: `true`
--8<-- "docs/reference/cli/pixi/workspace/feature/remove_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/integration/editor/zed.md:
--------------------------------------------------------------------------------
```markdown
[Zed](https://zed.dev/) is a code editor that provides support for many languages out of the box.
By installing extensions more languages can be supported.
## Python
Zed supports Pixi and Python out of the box.
If Zed hasn't done so already, select a suitable Pixi environment in the environment selector and you are good to go!
## Direnv
Zed supports Direnv out of the box.
Set up Direnv with Pixi as described in our [Direnv page](../third_party/direnv.md) and Zed will activate the environment automatically.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/global/shortcut.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi global shortcut
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [global](../global.md) shortcut
Interact with the shortcuts on your machine
--8<-- "docs/reference/cli/pixi/global/shortcut_extender:description"
## Usage
```
pixi global shortcut <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](shortcut/add.md) | Add a shortcut from an environment to your machine. |
| [`remove`](shortcut/remove.md) | Remove shortcuts from your machine |
--8<-- "docs/reference/cli/pixi/global/shortcut_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/environment/remove.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace environment remove
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [environment](../environment.md) remove
Remove an environment from the manifest file
--8<-- "docs/reference/cli/pixi/workspace/environment/remove_extender:description"
## Usage
```
pixi workspace environment remove <NAME>
```
## Arguments
- <a id="arg-<NAME>" href="#arg-<NAME>">`<NAME>`</a>
: The name of the environment to remove
<br>**required**: `true`
--8<-- "docs/reference/cli/pixi/workspace/environment/remove_extender:example"
```
--------------------------------------------------------------------------------
/.github/workflows/README-codeql.md:
--------------------------------------------------------------------------------
```markdown
# CodeQL Security Analysis
> Updated on 2025-07-21 by @KemingHe
## Overview
Comprehensive security analysis via GitHub's CodeQL with automated vulnerability detection.
## Configuration
- **File**: [`codeql.yml`](./codeql.yml)
- **Schedule**: Weekly (Mondays 1:24 AM UTC)
- **Triggers**: Push to main, pull requests
- **Bot Protection**: Skips analysis on `github-actions[bot]` commits
## Language Support
- **Active**: Actions workflows, Python code
- **Available**: Full CodeQL matrix (C/C++, C#, Go, Java/Kotlin, JavaScript/TypeScript, Ruby, Swift, Rust)
- **Build Mode**: Automatic detection for compiled languages
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/global/edit.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi global edit
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [global](../global.md) edit
Edit the global manifest file
--8<-- "docs/reference/cli/pixi/global/edit_extender:description"
## Usage
```
pixi global edit [EDITOR]
```
## Arguments
- <a id="arg-<EDITOR>" href="#arg-<EDITOR>">`<EDITOR>`</a>
: The editor to use, defaults to `EDITOR` environment variable or `nano` on Unix and `notepad` on Windows
<br>**env**: `EDITOR`
## Description
Edit the global manifest file
Opens your editor to edit the global manifest file.
--8<-- "docs/reference/cli/pixi/global/edit_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/poetry/community.md:
--------------------------------------------------------------------------------
```markdown
---
title: "Community"
draft: false
type: docs
layout: single
menu:
docs:
weight: 105
---
# Community
## Badge
For any projects using Poetry, you may add its official badge somewhere prominent like the README.
[](https://python-poetry.org/)
**Markdown**
```md
[](https://python-poetry.org/)
```
**reStructuredText**
```rst
.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
:alt: Poetry
:target: https://python-poetry.org/
```
```
--------------------------------------------------------------------------------
/src/assets/uv/guides/integration/index.md:
--------------------------------------------------------------------------------
```markdown
# Integration guides
Learn how to integrate uv with other software:
- [Using in Docker images](./docker.md)
- [Using with Jupyter notebooks](./jupyter.md)
- [Using with marimo notebooks](./marimo.md)
- [Using with pre-commit](./pre-commit.md)
- [Using in GitHub Actions](./github.md)
- [Using in GitLab CI/CD](./gitlab.md)
- [Using with alternative package indexes](./alternative-indexes.md)
- [Installing PyTorch](./pytorch.md)
- [Building a FastAPI application](./fastapi.md)
- [Using with AWS Lambda](./aws-lambda.md)
- [Using with Coiled](./coiled.md)
Or, explore the [concept documentation](../../concepts/index.md) for comprehensive breakdown of each
feature.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/name/set.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace name set
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [name](../name.md) set
Set the workspace name
--8<-- "docs/reference/cli/pixi/workspace/name/set_extender:description"
## Usage
```
pixi workspace name set <NAME>
```
## Arguments
- <a id="arg-<NAME>" href="#arg-<NAME>">`<NAME>`</a>
: The workspace name, please only use lowercase letters (a-z), digits (0-9), hyphens (-), and underscores (_)
<br>**required**: `true`
## Description
Set the workspace name.
Example: `pixi workspace name set "my-workspace"`
--8<-- "docs/reference/cli/pixi/workspace/name/set_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pip/html/cli/index.md:
--------------------------------------------------------------------------------
```markdown
# Commands
The general options that apply to all the commands listed below can be
found [under the `pip` page in this section](pip).
```{toctree}
:maxdepth: 1
:hidden:
pip
```
```{toctree}
:maxdepth: 1
:caption: Environment Management and Introspection
pip_install
pip_uninstall
pip_inspect
pip_list
pip_show
pip_freeze
pip_check
```
```{toctree}
:maxdepth: 1
:caption: Resolving dependencies
pip_lock
```
```{toctree}
:maxdepth: 1
:caption: Handling Distribution Files
pip_download
pip_wheel
pip_hash
```
```{toctree}
:maxdepth: 1
:caption: Package Index information
pip_search
pip_index
```
```{toctree}
:maxdepth: 1
:caption: Managing pip itself
pip_cache
pip_config
pip_debug
```
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/description/set.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace description set
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [description](../description.md) set
Set the workspace description
--8<-- "docs/reference/cli/pixi/workspace/description/set_extender:description"
## Usage
```
pixi workspace description set <DESCRIPTION>
```
## Arguments
- <a id="arg-<DESCRIPTION>" href="#arg-<DESCRIPTION>">`<DESCRIPTION>`</a>
: The workspace description
<br>**required**: `true`
## Description
Set the workspace description.
Example: `pixi workspace description set "My awesome workspace"`
--8<-- "docs/reference/cli/pixi/workspace/description/set_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/requires-pixi/set.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace requires-pixi set
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [requires-pixi](../requires-pixi.md) set
Set the pixi minimum version requirement
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/set_extender:description"
## Usage
```
pixi workspace requires-pixi set <VERSION>
```
## Arguments
- <a id="arg-<VERSION>" href="#arg-<VERSION>">`<VERSION>`</a>
: The required pixi version
<br>**required**: `true`
## Description
Set the pixi minimum version requirement.
Example: `pixi workspace pixi-minimum set 0.42`
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi/set_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/export.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace export
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) export
Commands to export workspaces to other formats
--8<-- "docs/reference/cli/pixi/workspace/export_extender:description"
## Usage
```
pixi workspace export <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`conda-explicit-spec`](export/conda-explicit-spec.md) | Export workspace environment to a conda explicit specification file |
| [`conda-environment`](export/conda-environment.md) | Export workspace environment to a conda environment.yaml file |
--8<-- "docs/reference/cli/pixi/workspace/export_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/pip/inspection.md:
--------------------------------------------------------------------------------
```markdown
# Inspecting environments
## Listing installed packages
To list all the packages in the environment:
```console
$ uv pip list
```
To list the packages in a JSON format:
```console
$ uv pip list --format json
```
To list all the packages in the environment in a `requirements.txt` format:
```console
$ uv pip freeze
```
## Inspecting a package
To show information about an installed package, e.g., `numpy`:
```console
$ uv pip show numpy
```
Multiple packages can be inspected at once.
## Verifying an environment
It is possible to install packages with conflicting requirements into an environment if installed in
multiple steps.
To check for conflicts or missing dependencies in the environment:
```console
$ uv pip check
```
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/name.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace name
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) name
Commands to manage workspace name
--8<-- "docs/reference/cli/pixi/workspace/name_extender:description"
## Usage
```
pixi workspace name [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`get`](name/get.md) | Get the workspace name |
| [`set`](name/set.md) | Set the workspace name |
## 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
--8<-- "docs/reference/cli/pixi/workspace/name_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/info.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi info
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) info
Information about the system, workspace and environments for the current machine
--8<-- "docs/reference/cli/pixi/info_extender:description"
## Usage
```
pixi info [OPTIONS]
```
## Options
- <a id="arg---extended" href="#arg---extended">`--extended`</a>
: Show cache and environment size
- <a id="arg---json" href="#arg---json">`--json`</a>
: Whether to show the output as JSON or not
## 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
--8<-- "docs/reference/cli/pixi/info_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/concepts/projects/index.md:
--------------------------------------------------------------------------------
```markdown
# Projects
Projects help manage Python code spanning multiple files.
!!! tip
Looking for an introduction to creating a project with uv? See the [projects guide](../../guides/projects.md) first.
Working on projects is a core part of the uv experience. Learn more about using projects:
- [Understanding project structure and files](./layout.md)
- [Creating new projects](./init.md)
- [Managing project dependencies](./dependencies.md)
- [Running commands and scripts in a project](./run.md)
- [Using lockfiles and syncing the environment](./sync.md)
- [Configuring the project for advanced use cases](./config.md)
- [Building distributions to publish a project](./build.md)
- [Using workspaces to work on multiple projects at once](./workspaces.md)
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/config.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi config
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) config
Configuration management
--8<-- "docs/reference/cli/pixi/config_extender:description"
## Usage
```
pixi config <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`edit`](config/edit.md) | Edit the configuration file |
| [`list`](config/list.md) | List configuration values |
| [`prepend`](config/prepend.md) | Prepend a value to a list configuration key |
| [`append`](config/append.md) | Append a value to a list configuration key |
| [`set`](config/set.md) | Set a configuration value |
| [`unset`](config/unset.md) | Unset a configuration value |
--8<-- "docs/reference/cli/pixi/config_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/system-requirements/list.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace system-requirements list
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [system-requirements](../system-requirements.md) list
List the environments in the manifest file
--8<-- "docs/reference/cli/pixi/workspace/system-requirements/list_extender:description"
## Usage
```
pixi workspace system-requirements list [OPTIONS]
```
## Options
- <a id="arg---json" href="#arg---json">`--json`</a>
: List the system requirements in JSON format
- <a id="arg---environment" href="#arg---environment">`--environment (-e) <ENVIRONMENT>`</a>
: The environment to list the system requirements for
--8<-- "docs/reference/cli/pixi/workspace/system-requirements/list_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/task/remove.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi task remove
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [task](../task.md) remove
Remove a command from the workspace
--8<-- "docs/reference/cli/pixi/task/remove_extender:description"
## Usage
```
pixi task remove [OPTIONS] [TASK_NAME]...
```
## Arguments
- <a id="arg-<TASK_NAME>" href="#arg-<TASK_NAME>">`<TASK_NAME>`</a>
: Task name to remove
<br>May be provided more than once.
## Options
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
: The platform for which the task should be removed
- <a id="arg---feature" href="#arg---feature">`--feature (-f) <FEATURE>`</a>
: The feature for which the task should be removed
--8<-- "docs/reference/cli/pixi/task/remove_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/task/list.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi task list
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [task](../task.md) list
List all tasks in the workspace
--8<-- "docs/reference/cli/pixi/task/list_extender:description"
## Usage
```
pixi task list [OPTIONS]
```
## Options
- <a id="arg---summary" href="#arg---summary">`--summary (-s)`</a>
: Tasks available for this machine per environment
- <a id="arg---environment" href="#arg---environment">`--environment (-e) <ENVIRONMENT>`</a>
: The environment the list should be generated for. If not specified, the default environment is used
- <a id="arg---json" href="#arg---json">`--json`</a>
: List as json instead of a tree If not specified, the default environment is used
--8<-- "docs/reference/cli/pixi/task/list_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/feature.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace feature
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) feature
Commands to manage workspace features
--8<-- "docs/reference/cli/pixi/workspace/feature_extender:description"
## Usage
```
pixi workspace feature [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`list`](feature/list.md) | List the features in the manifest file |
| [`remove`](feature/remove.md) | Remove a feature from the manifest 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
--8<-- "docs/reference/cli/pixi/workspace/feature_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/description.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace description
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) description
Commands to manage workspace description
--8<-- "docs/reference/cli/pixi/workspace/description_extender:description"
## Usage
```
pixi workspace description [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`get`](description/get.md) | Get the workspace description |
| [`set`](description/set.md) | Set the workspace description |
## 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
--8<-- "docs/reference/cli/pixi/workspace/description_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/task.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi task
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) task
Interact with tasks in the workspace
--8<-- "docs/reference/cli/pixi/task_extender:description"
## Usage
```
pixi task [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](task/add.md) | Add a command to the workspace |
| [`remove`](task/remove.md) | Remove a command from the workspace |
| [`alias`](task/alias.md) | Alias another specific command |
| [`list`](task/list.md) | List all tasks in the workspace |
## 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
--8<-- "docs/reference/cli/pixi/task_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/concepts/authentication/third-party.md:
--------------------------------------------------------------------------------
```markdown
# Third-party services
## Authentication with alternative package indexes
See the [alternative indexes integration guide](../../guides/integration/alternative-indexes.md) for
details on authentication with popular alternative Python package indexes.
## Hugging Face support
uv supports automatic authentication for the Hugging Face Hub. Specifically, if the `HF_TOKEN`
environment variable is set, uv will propagate it to requests to `huggingface.co`.
This is particularly useful for accessing private scripts in Hugging Face Datasets. For example, you
can run the following command to execute the script `main.py` script from a private dataset:
```console
$ HF_TOKEN=hf_... uv run https://huggingface.co/datasets/<user>/<name>/resolve/<branch>/main.py
```
You can disable automatic Hugging Face authentication by setting the `UV_NO_HF_TOKEN=1` environment
variable.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/system-requirements.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace system-requirements
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) system-requirements
Commands to manage workspace system requirements
--8<-- "docs/reference/cli/pixi/workspace/system-requirements_extender:description"
## Usage
```
pixi workspace system-requirements [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](system-requirements/add.md) | Adds an environment to the manifest file |
| [`list`](system-requirements/list.md) | List the environments in the manifest 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
--8<-- "docs/reference/cli/pixi/workspace/system-requirements_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/channel.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace channel
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) channel
Commands to manage workspace channels
--8<-- "docs/reference/cli/pixi/workspace/channel_extender:description"
## Usage
```
pixi workspace channel [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](channel/add.md) | Adds a channel to the manifest and updates the lockfile |
| [`list`](channel/list.md) | List the channels in the manifest |
| [`remove`](channel/remove.md) | Remove channel(s) from the manifest and updates the lockfile |
## 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
--8<-- "docs/reference/cli/pixi/workspace/channel_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/task/alias.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi task alias
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [task](../task.md) alias
Alias another specific command
--8<-- "docs/reference/cli/pixi/task/alias_extender:description"
## Usage
```
pixi task alias [OPTIONS] <ALIAS> <DEPENDS_ON>...
```
## Arguments
- <a id="arg-<ALIAS>" href="#arg-<ALIAS>">`<ALIAS>`</a>
: Alias name
<br>**required**: `true`
- <a id="arg-<DEPENDS_ON>" href="#arg-<DEPENDS_ON>">`<DEPENDS_ON>`</a>
: Depends on these tasks to execute
<br>May be provided more than once.
<br>**required**: `true`
## Options
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
: The platform for which the alias should be added
- <a id="arg---description" href="#arg---description">`--description <DESCRIPTION>`</a>
: The description of the alias task
--8<-- "docs/reference/cli/pixi/task/alias_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/environment.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace environment
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) environment
Commands to manage workspace environments
--8<-- "docs/reference/cli/pixi/workspace/environment_extender:description"
## Usage
```
pixi workspace environment [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](environment/add.md) | Adds an environment to the manifest file |
| [`list`](environment/list.md) | List the environments in the manifest file |
| [`remove`](environment/remove.md) | Remove an environment from the manifest 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
--8<-- "docs/reference/cli/pixi/workspace/environment_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/lock.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi lock
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) lock
Solve environment and update the lock file without installing the environments
--8<-- "docs/reference/cli/pixi/lock_extender:description"
## Usage
```
pixi lock [OPTIONS]
```
## Options
- <a id="arg---json" href="#arg---json">`--json`</a>
: Output the changes in JSON format
- <a id="arg---check" href="#arg---check">`--check`</a>
: Check if any changes have been made to the lock file. If yes, exit with a non-zero code
## Update Options
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
: Don't modify the environment, only modify the lock-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
--8<-- "docs/reference/cli/pixi/lock_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pip/html/topics/python-option.md:
--------------------------------------------------------------------------------
```markdown
# Managing a different Python interpreter
```{versionadded} 22.3
```
Occasionally, you may want to use pip to manage a Python installation other than
the one pip is installed into. In this case, you can use the `--python` option
to specify the interpreter you want to manage. This option can take one of two
values:
1. The path to a Python executable.
2. The path to a virtual environment.
In both cases, pip will run exactly as if it had been invoked from that Python
environment.
One example of where this might be useful is to manage a virtual environment
that does not have pip installed.
```{pip-cli}
$ python -m venv .venv --without-pip
$ pip --python .venv install SomePackage
[...]
Successfully installed SomePackage
```
You could also use `--python .venv/bin/python` (or on Windows,
`--python .venv\Scripts\python.exe`) if you wanted to be explicit, but the
virtual environment name is shorter and works exactly the same.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/platform/add.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace platform add
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [platform](../platform.md) add
Adds a platform(s) to the workspace file and updates the lockfile
--8<-- "docs/reference/cli/pixi/workspace/platform/add_extender:description"
## Usage
```
pixi workspace platform add [OPTIONS] <PLATFORM>...
```
## Arguments
- <a id="arg-<PLATFORM>" href="#arg-<PLATFORM>">`<PLATFORM>`</a>
: The platform name(s) to add
<br>May be provided more than once.
<br>**required**: `true`
## Options
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
: Don't update the environment, only add changed packages to the lock-file
- <a id="arg---feature" href="#arg---feature">`--feature (-f) <FEATURE>`</a>
: The name of the feature to add the platform to
--8<-- "docs/reference/cli/pixi/workspace/platform/add_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/platform.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace platform
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) platform
Commands to manage workspace platforms
--8<-- "docs/reference/cli/pixi/workspace/platform_extender:description"
## Usage
```
pixi workspace platform [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](platform/add.md) | Adds a platform(s) to the workspace file and updates the lockfile |
| [`list`](platform/list.md) | List the platforms in the workspace file |
| [`remove`](platform/remove.md) | Remove platform(s) from the workspace file and updates the lockfile |
## 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
--8<-- "docs/reference/cli/pixi/workspace/platform_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/conda/source/dev-guide/releasing.md:
--------------------------------------------------------------------------------
```markdown
# Releasing
Conda's releases may be performed via the [rever command](https://regro.github.io/rever-docs/).
Rever is configured to perform the activities for a typical conda release.
To cut a release, simply run `rever <X.Y.Z>` where `<X.Y.Z>` is the
release number that you want bump to. For example, `rever 1.2.3`.
However, it is always good idea to make sure that the you have permissions
everywhere to actually perform the release. So it is customary to run
`rever check` before the release, just to make sure.
The standard workflow is thus:
```bash
$ rever check
$ rever 1.2.3
```
If for some reason a release fails partway through, or you want to claw back a
release that you have made, rever allows you to undo activities. If you find yourself
in this pickle, you can pass the `--undo` option a comma-separated list of
activities you'd like to undo. For example:
```bash
$ rever --undo tag,changelog,authors 1.2.3
```
Happy releasing!
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/upload/quetz.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi upload quetz
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [upload](../upload.md) quetz
Upload to a Quetz server. Authentication is used from the keychain / auth-file
--8<-- "docs/reference/cli/pixi/upload/quetz_extender:description"
## Usage
```
pixi upload quetz [OPTIONS] --url <URL> --channel <CHANNELS>
```
## Options
- <a id="arg---url" href="#arg---url">`--url (-u) <URL>`</a>
: The URL to your Quetz server
<br>**required**: `true`
<br>**env**: `QUETZ_SERVER_URL`
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNELS>`</a>
: The URL to your channel
<br>**required**: `true`
<br>**env**: `QUETZ_CHANNEL`
- <a id="arg---api-key" href="#arg---api-key">`--api-key (-a) <API_KEY>`</a>
: The Quetz API key, if none is provided, the token is read from the keychain / auth-file
<br>**env**: `QUETZ_API_KEY`
--8<-- "docs/reference/cli/pixi/upload/quetz_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/upload/artifactory.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi upload artifactory
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [upload](../upload.md) artifactory
Options for uploading to a Artifactory channel. Authentication is used from the keychain / auth-file
--8<-- "docs/reference/cli/pixi/upload/artifactory_extender:description"
## Usage
```
pixi upload artifactory [OPTIONS] --url <URL> --channel <CHANNELS>
```
## Options
- <a id="arg---url" href="#arg---url">`--url (-u) <URL>`</a>
: The URL to your Artifactory server
<br>**required**: `true`
<br>**env**: `ARTIFACTORY_SERVER_URL`
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNELS>`</a>
: The URL to your channel
<br>**required**: `true`
<br>**env**: `ARTIFACTORY_CHANNEL`
- <a id="arg---token" href="#arg---token">`--token (-t) <TOKEN>`</a>
: Your Artifactory token
<br>**env**: `ARTIFACTORY_TOKEN`
--8<-- "docs/reference/cli/pixi/upload/artifactory_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/platform/remove.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace platform remove
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [platform](../platform.md) remove
Remove platform(s) from the workspace file and updates the lockfile
--8<-- "docs/reference/cli/pixi/workspace/platform/remove_extender:description"
## Usage
```
pixi workspace platform remove [OPTIONS] <PLATFORM>...
```
## Arguments
- <a id="arg-<PLATFORM>" href="#arg-<PLATFORM>">`<PLATFORM>`</a>
: The platform name to remove
<br>May be provided more than once.
<br>**required**: `true`
## Options
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
: Don't update the environment, only remove the platform(s) from the lock-file
- <a id="arg---feature" href="#arg---feature">`--feature (-f) <FEATURE>`</a>
: The name of the feature to remove the platform from
--8<-- "docs/reference/cli/pixi/workspace/platform/remove_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/self-update.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi self-update
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) self-update
Update pixi to the latest version or a specific version
--8<-- "docs/reference/cli/pixi/self-update_extender:description"
## Usage
```
pixi self-update [OPTIONS]
```
## Options
- <a id="arg---version" href="#arg---version">`--version <VERSION>`</a>
: The desired version (to downgrade or upgrade to)
- <a id="arg---dry-run" href="#arg---dry-run">`--dry-run`</a>
: Only show release notes, do not modify the binary
- <a id="arg---force" href="#arg---force">`--force`</a>
: Force download the desired version when not exactly same with the current. If no desired version, always replace with the latest version
<br>**default**: `false`
- <a id="arg---no-release-note" href="#arg---no-release-note">`--no-release-note`</a>
: Skip printing the release notes
<br>**default**: `false`
--8<-- "docs/reference/cli/pixi/self-update_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/version.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace version
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) version
Commands to manage workspace version
--8<-- "docs/reference/cli/pixi/workspace/version_extender:description"
## Usage
```
pixi workspace version [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`get`](version/get.md) | Get the workspace version |
| [`set`](version/set.md) | Set the workspace version |
| [`major`](version/major.md) | Bump the workspace version to MAJOR |
| [`minor`](version/minor.md) | Bump the workspace version to MINOR |
| [`patch`](version/patch.md) | Bump the workspace version to PATCH |
## 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
--8<-- "docs/reference/cli/pixi/workspace/version_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/global/tree.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi global tree
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [global](../global.md) tree
Show a tree of dependencies for a specific global environment
--8<-- "docs/reference/cli/pixi/global/tree_extender:description"
## Usage
```
pixi global tree [OPTIONS] --environment <ENVIRONMENT> [REGEX]
```
## Arguments
- <a id="arg-<REGEX>" href="#arg-<REGEX>">`<REGEX>`</a>
: List only packages matching a regular expression
## Options
- <a id="arg---environment" href="#arg---environment">`--environment (-e) <ENVIRONMENT>`</a>
: The environment to list packages for
<br>**required**: `true`
- <a id="arg---invert" href="#arg---invert">`--invert (-i)`</a>
: Invert tree and show what depends on a given package in the regex argument
## Description
Show a tree of a global environment dependencies
Dependency names highlighted in green are directly specified in the manifest.
--8<-- "docs/reference/cli/pixi/global/tree_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/global/expose.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi global expose
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [global](../global.md) expose
Interact with the exposure of binaries in the global environment
--8<-- "docs/reference/cli/pixi/global/expose_extender:description"
## Usage
```
pixi global expose <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](expose/add.md) | Add exposed binaries from an environment to your global environment |
| [`remove`](expose/remove.md) | Remove exposed binaries from the global environment |
## Description
Interact with the exposure of binaries in the global environment
`pixi global expose add python310=python3.10 --environment myenv` will expose the `python3.10` executable as `python310` from the environment `myenv`
`pixi global expose remove python310 --environment myenv` will remove the exposed name `python310` from the environment `myenv`
--8<-- "docs/reference/cli/pixi/global/expose_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/global/upgrade.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi global upgrade
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [global](../global.md) upgrade
Upgrade specific package which is installed globally. This command has been removed, please use `pixi global update` instead
--8<-- "docs/reference/cli/pixi/global/upgrade_extender:description"
## Usage
```
pixi global upgrade [OPTIONS] [SPECS]...
```
## Arguments
- <a id="arg-<SPECS>" href="#arg-<SPECS>">`<SPECS>`</a>
: Specifies the packages to upgrade
<br>May be provided more than once.
## Options
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNEL>`</a>
: The channels to consider as a name or a url. Multiple channels can be specified by using this field multiple times
<br>May be provided more than once.
- <a id="arg---platform" href="#arg---platform">`--platform <PLATFORM>`</a>
: The platform to install the package for
<br>**default**: `current_platform`
--8<-- "docs/reference/cli/pixi/global/upgrade_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/requires-pixi.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace requires-pixi
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [workspace](../workspace.md) requires-pixi
Commands to manage the pixi minimum version requirement
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi_extender:description"
## Usage
```
pixi workspace requires-pixi [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`get`](requires-pixi/get.md) | Get the pixi minimum version requirement |
| [`set`](requires-pixi/set.md) | Set the pixi minimum version requirement |
| [`unset`](requires-pixi/unset.md) | Remove the pixi minimum version requirement |
| [`verify`](requires-pixi/verify.md) | Verify the pixi minimum version requirement |
## 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
--8<-- "docs/reference/cli/pixi/workspace/requires-pixi_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/config/edit.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi config edit
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [config](../config.md) edit
Edit the configuration file
--8<-- "docs/reference/cli/pixi/config/edit_extender:description"
## Usage
```
pixi config edit [OPTIONS] [EDITOR]
```
## Arguments
- <a id="arg-<EDITOR>" href="#arg-<EDITOR>">`<EDITOR>`</a>
: The editor to use, defaults to `EDITOR` environment variable or `nano` on Unix and `notepad` on Windows
<br>**env**: `EDITOR`
## Config Options
- <a id="arg---local" href="#arg---local">`--local (-l)`</a>
: Operation on project-local configuration
- <a id="arg---global" href="#arg---global">`--global (-g)`</a>
: Operation on global configuration
- <a id="arg---system" href="#arg---system">`--system (-s)`</a>
: Operation on system configuration
## 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
--8<-- "docs/reference/cli/pixi/config/edit_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/config/unset.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi config unset
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [config](../config.md) unset
Unset a configuration value
--8<-- "docs/reference/cli/pixi/config/unset_extender:description"
## Usage
```
pixi config unset [OPTIONS] <KEY>
```
## Arguments
- <a id="arg-<KEY>" href="#arg-<KEY>">`<KEY>`</a>
: Configuration key to unset
<br>**required**: `true`
## Config Options
- <a id="arg---local" href="#arg---local">`--local (-l)`</a>
: Operation on project-local configuration
- <a id="arg---global" href="#arg---global">`--global (-g)`</a>
: Operation on global configuration
- <a id="arg---system" href="#arg---system">`--system (-s)`</a>
: Operation on system configuration
## 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
## Description
Unset a configuration value
Example: `pixi config unset default-channels`
--8<-- "docs/reference/cli/pixi/config/unset_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/system-requirements/add.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace system-requirements add
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [system-requirements](../system-requirements.md) add
Adds an environment to the manifest file
--8<-- "docs/reference/cli/pixi/workspace/system-requirements/add_extender:description"
## Usage
```
pixi workspace system-requirements add [OPTIONS] <REQUIREMENT> <VERSION>
```
## Arguments
- <a id="arg-<REQUIREMENT>" href="#arg-<REQUIREMENT>">`<REQUIREMENT>`</a>
: The name of the system requirement to add
<br>**required**: `true`
<br>**options**: `linux`, `cuda`, `macos`, `glibc`, `other-libc`
- <a id="arg-<VERSION>" href="#arg-<VERSION>">`<VERSION>`</a>
: The version of the requirement
<br>**required**: `true`
## Options
- <a id="arg---family" href="#arg---family">`--family <FAMILY>`</a>
: The Libc family, this can only be specified for requirement `other-libc`
- <a id="arg---feature" href="#arg---feature">`--feature (-f) <FEATURE>`</a>
: The name of the feature to modify
--8<-- "docs/reference/cli/pixi/workspace/system-requirements/add_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/config/list.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi config list
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [config](../config.md) list
List configuration values
--8<-- "docs/reference/cli/pixi/config/list_extender:description"
## Usage
```
pixi config list [OPTIONS] [KEY]
```
## Arguments
- <a id="arg-<KEY>" href="#arg-<KEY>">`<KEY>`</a>
: Configuration key to show (all if not provided)
## Options
- <a id="arg---json" href="#arg---json">`--json`</a>
: Output in JSON format
## Config Options
- <a id="arg---local" href="#arg---local">`--local (-l)`</a>
: Operation on project-local configuration
- <a id="arg---global" href="#arg---global">`--global (-g)`</a>
: Operation on global configuration
- <a id="arg---system" href="#arg---system">`--system (-s)`</a>
: Operation on system configuration
## 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
## Description
List configuration values
Example: `pixi config list default-channels`
--8<-- "docs/reference/cli/pixi/config/list_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/environment/add.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace environment add
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [environment](../environment.md) add
Adds an environment to the manifest file
--8<-- "docs/reference/cli/pixi/workspace/environment/add_extender:description"
## Usage
```
pixi workspace environment add [OPTIONS] <NAME>
```
## Arguments
- <a id="arg-<NAME>" href="#arg-<NAME>">`<NAME>`</a>
: The name of the environment to add
<br>**required**: `true`
## Options
- <a id="arg---feature" href="#arg---feature">`--feature (-f) <FEATURES>`</a>
: Features to add to the environment
<br>May be provided more than once.
- <a id="arg---solve-group" href="#arg---solve-group">`--solve-group <SOLVE_GROUP>`</a>
: The solve-group to add the environment to
- <a id="arg---no-default-feature" href="#arg---no-default-feature">`--no-default-feature`</a>
: Don't include the default feature in the environment
<br>**default**: `false`
- <a id="arg---force" href="#arg---force">`--force`</a>
: Update the manifest even if the environment already exists
<br>**default**: `false`
--8<-- "docs/reference/cli/pixi/workspace/environment/add_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/config/set.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi config set
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [config](../config.md) set
Set a configuration value
--8<-- "docs/reference/cli/pixi/config/set_extender:description"
## Usage
```
pixi config set [OPTIONS] <KEY> [VALUE]
```
## Arguments
- <a id="arg-<KEY>" href="#arg-<KEY>">`<KEY>`</a>
: Configuration key to set
<br>**required**: `true`
- <a id="arg-<VALUE>" href="#arg-<VALUE>">`<VALUE>`</a>
: Configuration value to set (key will be unset if value not provided)
## Config Options
- <a id="arg---local" href="#arg---local">`--local (-l)`</a>
: Operation on project-local configuration
- <a id="arg---global" href="#arg---global">`--global (-g)`</a>
: Operation on global configuration
- <a id="arg---system" href="#arg---system">`--system (-s)`</a>
: Operation on system configuration
## 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
## Description
Set a configuration value
Example: `pixi config set default-channels '["conda-forge", "bioconda"]'`
--8<-- "docs/reference/cli/pixi/config/set_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/clean.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi clean
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) clean
Cleanup the environments
--8<-- "docs/reference/cli/pixi/clean_extender:description"
## Usage
```
pixi clean [OPTIONS] [COMMAND]
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`cache`](clean/cache.md) | Clean the cache of your system which are touched by pixi |
## Options
- <a id="arg---environment" href="#arg---environment">`--environment (-e) <ENVIRONMENT>`</a>
: The environment directory to remove
- <a id="arg---activation-cache" href="#arg---activation-cache">`--activation-cache`</a>
: Only remove the activation cache
- <a id="arg---build" href="#arg---build">`--build`</a>
: Only remove the pixi-build cache
## 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
## Description
Cleanup the environments.
This command removes the information in the .pixi folder. You can specify the environment to remove with the `--environment` flag.
Use the `cache` subcommand to clean the cache.
--8<-- "docs/reference/cli/pixi/clean_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/search.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi search
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) search
Search a conda package
--8<-- "docs/reference/cli/pixi/search_extender:description"
## Usage
```
pixi search [OPTIONS] <PACKAGE>
```
## Arguments
- <a id="arg-<PACKAGE>" href="#arg-<PACKAGE>">`<PACKAGE>`</a>
: Name of package to search
<br>**required**: `true`
## Options
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNEL>`</a>
: The channels to consider as a name or a url. Multiple channels can be specified by using this field multiple times
<br>May be provided more than once.
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
: The platform to search for, defaults to current platform
<br>**default**: `current_platform`
- <a id="arg---limit" href="#arg---limit">`--limit (-l) <LIMIT>`</a>
: Limit the number of search results
## 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
## Description
Search a conda package
Its output will list the latest version of package.
--8<-- "docs/reference/cli/pixi/search_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/config/append.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi config append
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [config](../config.md) append
Append a value to a list configuration key
--8<-- "docs/reference/cli/pixi/config/append_extender:description"
## Usage
```
pixi config append [OPTIONS] <KEY> <VALUE>
```
## Arguments
- <a id="arg-<KEY>" href="#arg-<KEY>">`<KEY>`</a>
: Configuration key to set
<br>**required**: `true`
- <a id="arg-<VALUE>" href="#arg-<VALUE>">`<VALUE>`</a>
: Configuration value to (pre|ap)pend
<br>**required**: `true`
## Config Options
- <a id="arg---local" href="#arg---local">`--local (-l)`</a>
: Operation on project-local configuration
- <a id="arg---global" href="#arg---global">`--global (-g)`</a>
: Operation on global configuration
- <a id="arg---system" href="#arg---system">`--system (-s)`</a>
: Operation on system configuration
## 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
## Description
Append a value to a list configuration key
Example: `pixi config append default-channels bioconda`
--8<-- "docs/reference/cli/pixi/config/append_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/config/prepend.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi config prepend
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [config](../config.md) prepend
Prepend a value to a list configuration key
--8<-- "docs/reference/cli/pixi/config/prepend_extender:description"
## Usage
```
pixi config prepend [OPTIONS] <KEY> <VALUE>
```
## Arguments
- <a id="arg-<KEY>" href="#arg-<KEY>">`<KEY>`</a>
: Configuration key to set
<br>**required**: `true`
- <a id="arg-<VALUE>" href="#arg-<VALUE>">`<VALUE>`</a>
: Configuration value to (pre|ap)pend
<br>**required**: `true`
## Config Options
- <a id="arg---local" href="#arg---local">`--local (-l)`</a>
: Operation on project-local configuration
- <a id="arg---global" href="#arg---global">`--global (-g)`</a>
: Operation on global configuration
- <a id="arg---system" href="#arg---system">`--system (-s)`</a>
: Operation on system configuration
## 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
## Description
Prepend a value to a list configuration key
Example: `pixi config prepend default-channels bioconda`
--8<-- "docs/reference/cli/pixi/config/prepend_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/upload/anaconda.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi upload anaconda
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [upload](../upload.md) anaconda
Options for uploading to a Anaconda.org server
--8<-- "docs/reference/cli/pixi/upload/anaconda_extender:description"
## Usage
```
pixi upload anaconda [OPTIONS] --owner <OWNER>
```
## Options
- <a id="arg---owner" href="#arg---owner">`--owner (-o) <OWNER>`</a>
: The owner of the distribution (e.g. conda-forge or your username)
<br>**required**: `true`
<br>**env**: `ANACONDA_OWNER`
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNELS>`</a>
: The channel / label to upload the package to (e.g. main / rc)
<br>May be provided more than once.
<br>**env**: `ANACONDA_CHANNEL`
- <a id="arg---api-key" href="#arg---api-key">`--api-key (-a) <API_KEY>`</a>
: The Anaconda API key, if none is provided, the token is read from the keychain / auth-file
<br>**env**: `ANACONDA_API_KEY`
- <a id="arg---url" href="#arg---url">`--url (-u) <URL>`</a>
: The URL to the Anaconda server
<br>**env**: `ANACONDA_SERVER_URL`
- <a id="arg---force" href="#arg---force">`--force (-f)`</a>
: Replace files on conflict
<br>**env**: `ANACONDA_FORCE`
--8<-- "docs/reference/cli/pixi/upload/anaconda_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pip/html/ux-research-design/contribute.md:
--------------------------------------------------------------------------------
```markdown
# How to Contribute
## Participate in UX Research
It is important that we hear from pip users so that we can:
- Understand how pip is currently used by the Python community
- Understand how pip users _need_ pip to behave
- Understand how pip users _would like_ pip to behave
- Understand pip’s strengths and shortcomings
- Make useful design recommendations for improving pip
If you are interested in participating in pip user research, please [join pip’s user panel](https://mail.python.org/mailman3/lists/pip-ux-studies.python.org/).
## Test New Features
You can help the team by testing new features as they are released to the community.
## Report and Work on UX Issues
If you believe that you have found a user experience bug in pip, or you have ideas for how pip could be made better for all users, please file an issue on the [pip issue tracker](https://github.com/pypa/pip/issues/new).
You can also help improve pip’s user experience by [working on UX issues](https://github.com/pypa/pip/issues?q=is%3Aissue+label%3AUX+is%3Aopen). Issues that are ideal for new contributors are marked with “[good first issue](https://github.com/pypa/pip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)”. Explore the
[UX Guidance](guidance.md) if you have questions.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/clean/cache.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi clean cache
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [clean](../clean.md) cache
Clean the cache of your system which are touched by pixi
--8<-- "docs/reference/cli/pixi/clean/cache_extender:description"
## Usage
```
pixi clean cache [OPTIONS]
```
## Options
- <a id="arg---pypi" href="#arg---pypi">`--pypi`</a>
: Clean only the pypi related cache
- <a id="arg---conda" href="#arg---conda">`--conda`</a>
: Clean only the conda related cache
- <a id="arg---mapping" href="#arg---mapping">`--mapping`</a>
: Clean only the mapping cache
- <a id="arg---exec" href="#arg---exec">`--exec`</a>
: Clean only `exec` cache
- <a id="arg---repodata" href="#arg---repodata">`--repodata`</a>
: Clean only the repodata cache
- <a id="arg---build-backends" href="#arg---build-backends">`--build-backends`</a>
: Clean only the build backends environments cache
- <a id="arg---build" href="#arg---build">`--build`</a>
: Clean only the build related cache
- <a id="arg---yes" href="#arg---yes">`--yes (-y)`</a>
: Answer yes to all questions
## Description
Clean the cache of your system which are touched by pixi.
Specify the cache type to clean with the flags.
--8<-- "docs/reference/cli/pixi/clean/cache_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/pip/index.md:
--------------------------------------------------------------------------------
```markdown
# The pip interface
uv provides a drop-in replacement for common `pip`, `pip-tools`, and `virtualenv` commands. These
commands work directly with the virtual environment, in contrast to uv's primary interfaces where
the virtual environment is managed automatically. The `uv pip` interface exposes the speed and
functionality of uv to power users and projects that are not ready to transition away from `pip` and
`pip-tools`.
The following sections discuss the basics of using `uv pip`:
- [Creating and using environments](./environments.md)
- [Installing and managing packages](./packages.md)
- [Inspecting environments and packages](./inspection.md)
- [Declaring package dependencies](./dependencies.md)
- [Locking and syncing environments](./compile.md)
Please note these commands do not _exactly_ implement the interfaces and behavior of the tools they
are based on. The further you stray from common workflows, the more likely you are to encounter
differences. Consult the [pip-compatibility guide](./compatibility.md) for details.
!!! important
uv does not rely on or invoke pip. The pip interface is named as such to highlight its dedicated
purpose of providing low-level commands that match pip's interface and to separate it from the
rest of uv's commands which operate at a higher level of abstraction.
```
--------------------------------------------------------------------------------
/src/assets/pixi/integration/third_party/starship.md:
--------------------------------------------------------------------------------
```markdown
[Starship](https://starship.rs) is a cross-platform and cross-shell prompt for developers, similar to oh-my-zsh, but with a focus on performance and simplicity.
It also has full Pixi support.
You can install it using the following command:
```bash
pixi global install starship
```
!!!tip ""
For information about how to configure and set up starship, see the [official documentation](https://starship.rs/config/#pixi).
In order for starship to always find the right python executable, you can adjust its configuration file.
```toml title="~/.config/starship.toml"
[python]
# customize python binary path for pixi
python_binary = [
# this is the python from PATH if in a pixi shell
# (assuming you don't have python on your global PATH)
"python",
# fall back to pixi's python if it's available
".pixi/envs/default/bin/python",
]
```
By default, starship uses 🧚🏻 as pixi's symbol. You can adjust it as follows if you want a different symbol
```toml title="~/.config/starship.toml"
[pixi]
symbol = "📦 "
```
As starship already displays a custom message when a pixi environment is active, you can disable pixi's custom PS1:
```plaintext
pixi config set shell.change-ps1 "false"
```
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace/export/conda-environment.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace export conda-environment
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../../pixi.md) [workspace](../../workspace.md) [export](../export.md) conda-environment
Export workspace environment to a conda environment.yaml file
--8<-- "docs/reference/cli/pixi/workspace/export/conda-environment_extender:description"
## Usage
```
pixi workspace export conda-environment [OPTIONS] [OUTPUT_PATH]
```
## Arguments
- <a id="arg-<OUTPUT_PATH>" href="#arg-<OUTPUT_PATH>">`<OUTPUT_PATH>`</a>
: Explicit path to export the environment file to
## Options
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
: The platform to render the environment file for. Defaults to the current platform
- <a id="arg---environment" href="#arg---environment">`--environment (-e) <ENVIRONMENT>`</a>
: The environment to render the environment file for. Defaults to the default environment
- <a id="arg---name" href="#arg---name">`--name (-n) <NAME>`</a>
: The name to use for the rendered conda environment. Defaults to the environment name
## 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
--8<-- "docs/reference/cli/pixi/workspace/export/conda-environment_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/integration/extensions/pixi_install_to_prefix.md:
--------------------------------------------------------------------------------
```markdown
Pixi installs your environments to `.pixi/envs/<env-name>` by default.
If you want to install your environment to an arbitrary location on your system, you can use [`pixi-install-to-prefix`](https://github.com/pavelzw/pixi-install-to-prefix).
You can install `pixi-install-to-prefix` with:
```bash
pixi global install pixi-install-to-prefix
```
Instead of installing `pixi-install-to-prefix` globally, you can also use `pixi exec` to run `pixi-install-to-prefix` in a temporary environment:
```bash
pixi exec pixi-install-to-prefix ./my-environment
```
```text
Usage: pixi-install-to-prefix [OPTIONS] <PREFIX>
Arguments:
<PREFIX> The path to the prefix where you want to install the environment
Options:
-l, --lockfile <LOCKFILE> The path to the pixi lockfile [default: pixi.lock]
-e, --environment <ENVIRONMENT> The name of the pixi environment to install [default: default]
-p, --platform <PLATFORM> The platform you want to install for [default: <your-system-platform>]
-c, --config <CONFIG> The path to the pixi config file. By default, no config file is used
-s, --shell <SHELL> The shell(s) to generate activation scripts for. Default: see README
--no-activation-scripts Disable the generation of activation scripts
-v, --verbose... Increase logging verbosity
-q, --quiet... Decrease logging verbosity
-h, --help Print help
```
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/auth/login.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi auth login
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [auth](../auth.md) login
Store authentication information for a given host
--8<-- "docs/reference/cli/pixi/auth/login_extender:description"
## Usage
```
pixi auth login [OPTIONS] <HOST>
```
## Arguments
- <a id="arg-<HOST>" href="#arg-<HOST>">`<HOST>`</a>
: The host to authenticate with (e.g. prefix.dev)
<br>**required**: `true`
## Options
- <a id="arg---token" href="#arg---token">`--token <TOKEN>`</a>
: The token to use (for authentication with prefix.dev)
- <a id="arg---username" href="#arg---username">`--username <USERNAME>`</a>
: The username to use (for basic HTTP authentication)
- <a id="arg---password" href="#arg---password">`--password <PASSWORD>`</a>
: The password to use (for basic HTTP authentication)
- <a id="arg---conda-token" href="#arg---conda-token">`--conda-token <CONDA_TOKEN>`</a>
: The token to use on anaconda.org / quetz authentication
- <a id="arg---s3-access-key-id" href="#arg---s3-access-key-id">`--s3-access-key-id <S3_ACCESS_KEY_ID>`</a>
: The S3 access key ID
- <a id="arg---s3-secret-access-key" href="#arg---s3-secret-access-key">`--s3-secret-access-key <S3_SECRET_ACCESS_KEY>`</a>
: The S3 secret access key
- <a id="arg---s3-session-token" href="#arg---s3-session-token">`--s3-session-token <S3_SESSION_TOKEN>`</a>
: The S3 session token
--8<-- "docs/reference/cli/pixi/auth/login_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pdm/usage/uv.md:
--------------------------------------------------------------------------------
```markdown
# Use uv (Experimental)
+++ 2.19.0
PDM has experimental support for [uv](https://github.com/astral-sh/uv) as the resolver and installer. To enable it:
```
pdm config use_uv true
```
PDM will automatically detect the `uv` binary on your system. You need to install `uv` first. See [uv's installation guide](https://docs.astral.sh/uv/getting-started/installation/) for more details.
## Reuse the Python installations of uv
uv also supports installing Python interpreters. To avoid overhead, you can configure PDM to reuse the Python installations of uv by:
```
pdm config python.install_root $(uv python dir --color never)
```
## Limitations
Despite the significant performance improvements brought by uv, it is important to note the following limitations:
- The cache files are stored in uv's own cache directory, and you have to use `uv` command to manage them.
- PEP 582 local packages layout is not supported.
- `inherit_metadata` lock strategy is not supported by uv. This will be ignored when writing to the lock file.
- Update strategies other than `all` and `reuse` are not supported.
- Editable requirement must be a local path. Requirements like `-e git+<git_url>` are not supported.
- `excludes` settings under `[tool.pdm.resolution]` are not supported.
- Cross-platform lock targets are not needed by uv resolver, uv always generates universal lock files.
- `include_packages` and `exclude_packages` settings under `[tool.pdm.source]` are not supported.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/workspace.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi workspace
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) workspace
Modify the workspace configuration file through the command line
--8<-- "docs/reference/cli/pixi/workspace_extender:description"
## Usage
```
pixi workspace [OPTIONS] <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`channel`](workspace/channel.md) | Commands to manage workspace channels |
| [`description`](workspace/description.md) | Commands to manage workspace description |
| [`platform`](workspace/platform.md) | Commands to manage workspace platforms |
| [`version`](workspace/version.md) | Commands to manage workspace version |
| [`environment`](workspace/environment.md) | Commands to manage workspace environments |
| [`feature`](workspace/feature.md) | Commands to manage workspace features |
| [`export`](workspace/export.md) | Commands to export workspaces to other formats |
| [`name`](workspace/name.md) | Commands to manage workspace name |
| [`system-requirements`](workspace/system-requirements.md) | Commands to manage workspace system requirements |
| [`requires-pixi`](workspace/requires-pixi.md) | Commands to manage the pixi minimum version requirement |
## 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
--8<-- "docs/reference/cli/pixi/workspace_extender:example"
```
--------------------------------------------------------------------------------
/.github/workflows/auto-update-index.yml:
--------------------------------------------------------------------------------
```yaml
name: Update Search Index
on:
workflow_call: {}
workflow_dispatch: {} # Manual trigger for testing
jobs:
update-index:
name: Update Search Index
# Restrict to home repository and main branch only for security
if: github.repository == 'KemingHe/python-dependency-manager-companion-mcp-server' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
permissions:
contents: write # Required: commit search index updates
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install uv
# Pin 3rd-party action to v6.4.1 commit hash released on 2025-07-18 to prevent supply chain attacks
uses: astral-sh/setup-uv@7edac99f961f18b581bbd960d59d049f04c0002f
with:
version: "latest"
- name: Set up Python
run: uv python install
- name: Install dependencies
run: uv sync
- name: Build search index
run: uv run src/build_index.py
- name: Pull latest changes by previous workflows
run: git pull origin main
- name: Auto commit index changes
# Pin 3rd-party action to v6.0.1 commit hash released on 2025-06-11 to prevent supply chain attacks
uses: stefanzweifel/git-auto-commit-action@778341af668090896ca464160c2def5d1d1a3eb0
with:
commit_message: 'chore(src/index/): rebuild search index from updated documentation'
file_pattern: 'src/index/*'
```
--------------------------------------------------------------------------------
/src/assets/pixi/global_tools/trampolines.md:
--------------------------------------------------------------------------------
```markdown
## Trampolines
To increase efficiency, `pixi` uses *trampolines*—small, specialized binary files that manage configuration and environment setup before executing the main binary. The trampoline approach allows for skipping the execution of activation scripts that have a significant performance impact.
When you execute a globally installed executable, a trampoline performs the following sequence of steps:
* Each trampoline first reads a configuration file named after the binary being executed. This configuration file, in JSON format (e.g., `python.json`), contains key information about how the environment should be set up. The configuration file is stored in [`$PIXI_HOME`](../reference/environment_variables.md)`/bin/trampoline_configuration`.
* Once the configuration is loaded and the environment is set, the trampoline executes the original binary with the correct environment settings.
* When installing a new binary, a new trampoline is placed in the [`$PIXI_HOME`](../reference/environment_variables.md)`/bin` directory and is hard-linked to the [`$PIXI_HOME`](../reference/environment_variables.md)`/bin/trampoline_configuration/trampoline_bin`. This optimizes storage space and avoids duplication of the same trampoline.
The trampoline will take care that the `PATH` contains the newest changes on your local `PATH` while avoiding caching temporary `PATH` changes during installation.
If you want to control the base `PATH` pixi considers, you can set `export PIXI_BASE_PATH=$PATH` in your shell startup script.
```
--------------------------------------------------------------------------------
/.github/workflows/auto-update.yml:
--------------------------------------------------------------------------------
```yaml
name: Auto Update Orchestrator
on:
schedule:
# Tuesday 6pm ET (22:00 UTC, accounting for EST/EDT)
- cron: '0 22 * * 2'
workflow_dispatch: {} # Manual trigger for testing
jobs:
update-docs:
name: Update Documentation
# Restrict to home repository and main branch only for security
if: github.repository == 'KemingHe/python-dependency-manager-companion-mcp-server' && github.ref == 'refs/heads/main'
permissions:
contents: write # Required: commit documentation updates
uses: ./.github/workflows/auto-update-docs.yml
update-index:
name: Update Search Index
needs: update-docs
# Restrict to home repository and main branch only for security
if: github.repository == 'KemingHe/python-dependency-manager-companion-mcp-server' && github.ref == 'refs/heads/main'
permissions:
contents: write # Required: commit search index updates
uses: ./.github/workflows/auto-update-index.yml
publish:
name: Publish Image
needs: update-index
# Restrict to home repository and main branch only for security
if: github.repository == 'KemingHe/python-dependency-manager-companion-mcp-server' && github.ref == 'refs/heads/main'
permissions:
contents: read # Minimum: checkout repository
attestations: write # Required: artifact attestation
id-token: write # Required: OIDC token for attestation
uses: ./.github/workflows/auto-update-publish.yml
secrets: inherit # Required for workflow accessing env secrets
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/upload.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi upload
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) upload
Upload conda packages to various channels
--8<-- "docs/reference/cli/pixi/upload_extender:description"
## Usage
```
pixi upload [OPTIONS] [PACKAGE_FILES]... <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`quetz`](upload/quetz.md) | Upload to a Quetz server. Authentication is used from the keychain / auth-file |
| [`artifactory`](upload/artifactory.md) | Options for uploading to a Artifactory channel. Authentication is used from the keychain / auth-file |
| [`prefix`](upload/prefix.md) | Options for uploading to a prefix.dev server. Authentication is used from the keychain / auth-file |
| [`anaconda`](upload/anaconda.md) | Options for uploading to a Anaconda.org server |
| [`s3`](upload/s3.md) | Options for uploading to S3 |
## Arguments
- <a id="arg-<PACKAGE_FILES>" href="#arg-<PACKAGE_FILES>">`<PACKAGE_FILES>`</a>
: The package file to upload
<br>May be provided more than once.
## Options
- <a id="arg---allow-insecure-host" href="#arg---allow-insecure-host">`--allow-insecure-host <ALLOW_INSECURE_HOST>`</a>
: List of hosts for which SSL certificate verification should be skipped
<br>May be provided more than once.
## Description
Upload conda packages to various channels
Supported server types: prefix, anaconda, quetz, artifactory, s3, conda-forge
Use `pixi auth login` to authenticate with the server.
--8<-- "docs/reference/cli/pixi/upload_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/integration/third_party/direnv.md:
--------------------------------------------------------------------------------
```markdown
`direnv` is a tool which automatically activates an environment as soon as you enter a directory with a `.envrc` file that you accepted at some point.
This tutorial will demonstrate how to use `direnv` with Pixi`.
First install `direnv` by running the following command:
```bash
pixi global install direnv
```
Then create a `.envrc` file in your Pixi workspace root with the following content:
```shell title=".envrc"
watch_file pixi.lock # (1)!
eval "$(pixi shell-hook)" # (2)!
```
1. This ensures that every time your `pixi.lock` changes, `direnv` invokes the shell-hook again.
2. This installs the environment if needed, and activates it. `direnv` ensures that the environment is deactivated when you leave the directory.
```shell
$ cd my-project
direnv: error /my-project/.envrc is blocked. Run `direnv allow` to approve its content
$ direnv allow
direnv: loading /my-project/.envrc
✔ Project in /my-project is ready to use!
direnv: export +CONDA_DEFAULT_ENV +CONDA_PREFIX +PIXI_ENVIRONMENT_NAME +PIXI_ENVIRONMENT_PLATFORMS +PIXI_PROJECT_MANIFEST +PIXI_PROJECT_NAME +PIXI_PROJECT_ROOT +PIXI_PROJECT_VERSION +PIXI_PROMPT ~PATH
$ which python
/my-project/.pixi/envs/default/bin/python
$ cd ..
direnv: unloading
$ which python
python not found
```
While `direnv` comes with [hooks for the common shells](https://direnv.net/docs/hook.html),
these hooks into the shell should not be relied on when using and IDE.
Here you can see how to set up `direnv` for your favorite editor:
- [VSCode](../editor/vscode.md#direnv-extension)
- [Jetbrains](../editor/jetbrains.md#direnv)
- [Zed](../editor/zed.md)
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/global.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi global
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) global
Subcommand for global package management actions
--8<-- "docs/reference/cli/pixi/global_extender:description"
## Usage
```
pixi global <COMMAND>
```
## Subcommands
| Command | Description |
|---------|-------------|
| [`add`](global/add.md) | Adds dependencies to an environment |
| [`edit`](global/edit.md) | Edit the global manifest file |
| [`install`](global/install.md) | Installs the defined packages in a globally accessible location and exposes their command line applications. |
| [`uninstall`](global/uninstall.md) | Uninstalls environments from the global environment. |
| [`remove`](global/remove.md) | Removes dependencies from an environment |
| [`list`](global/list.md) | Lists global environments with their dependencies and exposed commands. Can also display all packages within a specific global environment when using the --environment flag. |
| [`sync`](global/sync.md) | Sync global manifest with installed environments |
| [`expose`](global/expose.md) | Interact with the exposure of binaries in the global environment |
| [`shortcut`](global/shortcut.md) | Interact with the shortcuts on your machine |
| [`update`](global/update.md) | Updates environments in the global environment |
| [`tree`](global/tree.md) | Show a tree of dependencies for a specific global environment |
## Description
Subcommand for global package management actions.
Install packages on the user level. Into to the [`$PIXI_HOME`] directory, which defaults to `~/.pixi`.
--8<-- "docs/reference/cli/pixi/global_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/pip/dependencies.md:
--------------------------------------------------------------------------------
```markdown
# Declaring dependencies
It is best practice to declare dependencies in a static file instead of modifying environments with
ad-hoc installations. Once dependencies are defined, they can be [locked](./compile.md) to create a
consistent, reproducible environment.
## Using `pyproject.toml`
The `pyproject.toml` file is the Python standard for defining configuration for a project.
To define project dependencies in a `pyproject.toml` file:
```toml title="pyproject.toml"
[project]
dependencies = [
"httpx",
"ruff>=0.3.0"
]
```
To define optional dependencies in a `pyproject.toml` file:
```toml title="pyproject.toml"
[project.optional-dependencies]
cli = [
"rich",
"click",
]
```
Each of the keys defines an "extra", which can be installed using the `--extra` and `--all-extras`
flags or `package[<extra>]` syntax. See the documentation on
[installing packages](./packages.md#installing-packages-from-files) for more details.
See the official
[`pyproject.toml` guide](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/) for
more details on getting started with a `pyproject.toml`.
## Using `requirements.in`
It is also common to use a lightweight
[requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) to
declare the dependencies for the project. Each requirement is defined on its own line. Commonly,
this file is called `requirements.in` to distinguish it from `requirements.txt` which is used for
the locked dependencies.
To define dependencies in a `requirements.in` file:
```python title="requirements.in"
httpx
ruff>=0.3.0
```
Optional dependencies groups are not supported in this format.
```
--------------------------------------------------------------------------------
/src/assets/pip/html/index.md:
--------------------------------------------------------------------------------
```markdown
---
hide-toc: true
---
# pip
pip is the [package installer for Python][recommended]. You can use it to
install packages from the [Python Package Index][pypi] and other indexes.
```{toctree}
:hidden:
getting-started
installation
user_guide
topics/index
reference/index
cli/index
```
```{toctree}
:caption: Project
:hidden:
development/index
ux-research-design/index
news
Code of Conduct <https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md>
GitHub <https://github.com/pypa/pip>
```
If you want to learn about how to use pip, check out the following resources:
- [Getting Started](getting-started)
- [Python Packaging User Guide](https://packaging.python.org)
If you find bugs, need help, or want to talk to the developers, use our mailing
lists or chat rooms:
- [GitHub Issues][issue-tracker]
- [Discourse channel][packaging-discourse]
- [User IRC][irc-pypa]
- [Development IRC][irc-pypa-dev]
[recommended]: https://packaging.python.org/guides/tool-recommendations/
[pypi]: https://pypi.org/
[issue-tracker]: https://github.com/pypa/pip/issues/
[packaging-discourse]: https://discuss.python.org/c/packaging/14
[irc-pypa]: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa
[irc-pypa-dev]: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa-dev
If you find any security issues, please report to [[email protected]](mailto:[email protected])
## Privacy Notice
Pip does not collect any telemetry, however, it will send
non-identifying environment information (Python version, OS, etc.) to any remote indices
used, who may choose to retain such information. Please consult PyPI's privacy
policy for their data collection and retention practices.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/upload/prefix.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi upload prefix
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [upload](../upload.md) prefix
Options for uploading to a prefix.dev server. Authentication is used from the keychain / auth-file
--8<-- "docs/reference/cli/pixi/upload/prefix_extender:description"
## Usage
```
pixi upload prefix [OPTIONS] --channel <CHANNEL>
```
## Options
- <a id="arg---url" href="#arg---url">`--url (-u) <URL>`</a>
: The URL to the prefix.dev server (only necessary for self-hosted instances)
<br>**env**: `PREFIX_SERVER_URL`
<br>**default**: `https://prefix.dev`
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNEL>`</a>
: The channel to upload the package to
<br>**required**: `true`
<br>**env**: `PREFIX_CHANNEL`
- <a id="arg---api-key" href="#arg---api-key">`--api-key (-a) <API_KEY>`</a>
: The prefix.dev API key, if none is provided, the token is read from the keychain / auth-file
<br>**env**: `PREFIX_API_KEY`
- <a id="arg---attestation" href="#arg---attestation">`--attestation <ATTESTATION>`</a>
: Upload an attestation file alongside the package. Note: if you add an attestation, you can _only_ upload a single package. Mutually exclusive with --generate-attestation
- <a id="arg---generate-attestation" href="#arg---generate-attestation">`--generate-attestation`</a>
: Automatically generate attestation using cosign in CI. Mutually exclusive with --attestation
- <a id="arg---skip-existing" href="#arg---skip-existing">`--skip-existing (-s)`</a>
: Skip upload if package already exists
- <a id="arg---force" href="#arg---force">`--force`</a>
: Force overwrite existing packages
--8<-- "docs/reference/cli/pixi/upload/prefix_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/upload/conda-forge.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi upload conda-forge
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [upload](../upload.md) conda-forge
Options for uploading to conda-forge
--8<-- "docs/reference/cli/pixi/upload/conda-forge_extender:description"
## Usage
```
pixi upload conda-forge [OPTIONS] --staging-token <STAGING_TOKEN> --feedstock <FEEDSTOCK> --feedstock-token <FEEDSTOCK_TOKEN>
```
## Options
- <a id="arg---staging-token" href="#arg---staging-token">`--staging-token <STAGING_TOKEN>`</a>
: The Anaconda API key
<br>**required**: `true`
<br>**env**: `STAGING_BINSTAR_TOKEN`
- <a id="arg---feedstock" href="#arg---feedstock">`--feedstock <FEEDSTOCK>`</a>
: The feedstock name
<br>**required**: `true`
<br>**env**: `FEEDSTOCK_NAME`
- <a id="arg---feedstock-token" href="#arg---feedstock-token">`--feedstock-token <FEEDSTOCK_TOKEN>`</a>
: The feedstock token
<br>**required**: `true`
<br>**env**: `FEEDSTOCK_TOKEN`
- <a id="arg---staging-channel" href="#arg---staging-channel">`--staging-channel <STAGING_CHANNEL>`</a>
: The staging channel name
<br>**env**: `STAGING_CHANNEL`
- <a id="arg---anaconda-url" href="#arg---anaconda-url">`--anaconda-url <ANACONDA_URL>`</a>
: The Anaconda Server URL
<br>**env**: `ANACONDA_SERVER_URL`
- <a id="arg---validation-endpoint" href="#arg---validation-endpoint">`--validation-endpoint <VALIDATION_ENDPOINT>`</a>
: The validation endpoint url
<br>**env**: `VALIDATION_ENDPOINT`
- <a id="arg---provider" href="#arg---provider">`--provider <PROVIDER>`</a>
: The CI provider
<br>**env**: `CI`
- <a id="arg---dry-run" href="#arg---dry-run">`--dry-run`</a>
: Dry run, don't actually upload anything
<br>**env**: `DRY_RUN`
--8<-- "docs/reference/cli/pixi/upload/conda-forge_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/upload/s3.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi upload s3
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [upload](../upload.md) s3
Options for uploading to S3
--8<-- "docs/reference/cli/pixi/upload/s3_extender:description"
## Usage
```
pixi upload s3 [OPTIONS] --channel <CHANNEL>
```
## Options
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNEL>`</a>
: The channel URL in the S3 bucket to upload the package to, e.g., `s3://my-bucket/my-channel`
<br>**required**: `true`
<br>**env**: `S3_CHANNEL`
- <a id="arg---force" href="#arg---force">`--force`</a>
: Replace files if it already exists
## S3 Credentials
- <a id="arg---endpoint-url" href="#arg---endpoint-url">`--endpoint-url <ENDPOINT_URL>`</a>
: The endpoint URL of the S3 backend
<br>**env**: `S3_ENDPOINT_URL`
- <a id="arg---region" href="#arg---region">`--region <REGION>`</a>
: The region of the S3 backend
<br>**env**: `S3_REGION`
- <a id="arg---access-key-id" href="#arg---access-key-id">`--access-key-id <ACCESS_KEY_ID>`</a>
: The access key ID for the S3 bucket
<br>**env**: `S3_ACCESS_KEY_ID`
- <a id="arg---secret-access-key" href="#arg---secret-access-key">`--secret-access-key <SECRET_ACCESS_KEY>`</a>
: The secret access key for the S3 bucket
<br>**env**: `S3_SECRET_ACCESS_KEY`
- <a id="arg---session-token" href="#arg---session-token">`--session-token <SESSION_TOKEN>`</a>
: The session token for the S3 bucket
<br>**env**: `S3_SESSION_TOKEN`
- <a id="arg---addressing-style" href="#arg---addressing-style">`--addressing-style <ADDRESSING_STYLE>`</a>
: How to address the bucket
<br>**env**: `S3_ADDRESSING_STYLE`
<br>**default**: `virtual-host`
<br>**options**: `virtual-host`, `path`
--8<-- "docs/reference/cli/pixi/upload/s3_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/init.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi init
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) init
Creates a new workspace
--8<-- "docs/reference/cli/pixi/init_extender:description"
## Usage
```
pixi init [OPTIONS] [PATH]
```
## Arguments
- <a id="arg-<PATH>" href="#arg-<PATH>">`<PATH>`</a>
: Where to place the workspace (defaults to current path)
<br>**default**: `.`
## Options
- <a id="arg---channel" href="#arg---channel">`--channel (-c) <CHANNEL>`</a>
: Channel to use in the workspace
<br>May be provided more than once.
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
: Platforms that the workspace supports
<br>May be provided more than once.
- <a id="arg---import" href="#arg---import">`--import (-i) <ENVIRONMENT_FILE>`</a>
: Environment.yml file to bootstrap the workspace
- <a id="arg---format" href="#arg---format">`--format <FORMAT>`</a>
: The manifest format to create
<br>**options**: `pixi`, `pyproject`, `mojoproject`
- <a id="arg---scm" href="#arg---scm">`--scm (-s) <SCM>`</a>
: Source Control Management used for this workspace
<br>**options**: `github`, `gitlab`, `codeberg`
- <a id="arg---conda-pypi-map" href="#arg---conda-pypi-map">`--conda-pypi-map <CONDA_PYPI_MAP>`</a>
: Set a mapping between conda channels and pypi channels
<br>May be provided more than once.
## Description
Creates a new workspace
This command is used to create a new workspace. It prepares a manifest and some helpers for the user to start working.
As pixi can both work with `pixi.toml` and `pyproject.toml` files, the user can choose which one to use with `--format`.
You can import an existing conda environment file with the `--import` flag.
--8<-- "docs/reference/cli/pixi/init_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pixi/integration/editor/r_studio.md:
--------------------------------------------------------------------------------
```markdown
You can use `pixi` to manage your R dependencies. The conda-forge channel contains a wide range of R packages that can be installed using `pixi`.
## Installing R packages
R packages are usually prefixed with `r-` in the conda-forge channel. To install an R package, you can use the following command:
```bash
pixi add r-<package-name>
# for example
pixi add r-ggplot2
```
## Using R packages in RStudio
To use the R packages installed by `pixi` in RStudio, you need to run `rstudio` from an activated environment. This can be achieved by running RStudio from `pixi shell` or from a task in the `pixi.toml` file.
## Full example
The full example can be found here: [RStudio example](https://github.com/prefix-dev/pixi/tree/main/examples/r).
Here is an example of a `pixi.toml` file that sets up an RStudio task:
```toml
[workspace]
name = "r"
channels = ["conda-forge"]
platforms = ["linux-64", "osx-64", "osx-arm64"]
[target.linux.tasks]
rstudio = "rstudio"
[target.osx.tasks]
rstudio = "open -a rstudio"
# or alternatively with the full path:
# rstudio = "/Applications/RStudio.app/Contents/MacOS/RStudio"
[dependencies]
r = ">=4.3,<5"
r-ggplot2 = ">=3.5.0,<3.6"
```
Once RStudio has loaded, you can execute the following R code that uses the `ggplot2` package:
```R
# Load the ggplot2 package
library(ggplot2)
# Load the built-in 'mtcars' dataset
data <- mtcars
# Create a scatterplot of 'mpg' vs 'wt'
ggplot(data, aes(x = wt, y = mpg)) +
geom_point() +
labs(x = "Weight (1000 lbs)", y = "Miles per Gallon") +
ggtitle("Fuel Efficiency vs. Weight")
```
!!! Note
This example assumes that you have installed RStudio system-wide.
We are working on updating RStudio as well as the R interpreter builds on Windows for maximum compatibility with `pixi`.
```
--------------------------------------------------------------------------------
/src/assets/pixi/advanced/pixi_shell.md:
--------------------------------------------------------------------------------
```markdown
The `pixi shell` command is similar to `conda activate` but works a little different under the hood.
Instead of requiring a change to your `~/.bashrc` or other files, it will launch a fresh shell.
That also means that, instead of `conda deactivate`, it's enough to just exit the current shell, e.g. by pressing `Ctrl+D`.
```shell
pixi shell
```
On Unix systems the shell command works by creating a "fake" PTY session that will start the shell, and then send a string like `source /tmp/activation-env-12345.sh` to the `stdin` in order to activate the environment. If you would peek under the hood of the the `shell` command, then you would see that this is the first thing executed in the new shell session.
The temporary script that we generate ends with `echo "PIXI_ENV_ACTIVATED"` which is used to detect if the environment was activated successfully. If we do not receive this string after three seconds, we will issue a warning to the user.
## Issues With Pixi Shell
As explained, `pixi shell` only works well if we execute the activation script _after_ launching shell. Certain commands that are run in the `~/.bashrc` might swallow the activation command, and the environment won't be activated.
For example, if your `~/.bashrc` contains code like the following, `pixi shell` has little chance to succeed:
```shell
# on WSL - the `wsl.exe` somehow takes over `stdin` and prevents `pixi shell` from succeeding
wsl.exe -d wsl-vpnkit --cd /app service wsl-vpnkit start
# on macOS or Linux, some users start fish or nushell from their `bashrc`
# If you wish to start an alternative shell from bash, it's better to do so
# from `~/.bash_profile` or `~/.profile`
if [[ $- = *i* ]]; then
exec ~/.pixi/bin/fish
fi
```
In order to fix this, we would advise you to follow the steps below to use `pixi shell-hook` instead.
--8<-- "docs/partials/conda-style-activation.md"
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/tree.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi tree
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../pixi.md) tree
Show a tree of workspace dependencies
--8<-- "docs/reference/cli/pixi/tree_extender:description"
## Usage
```
pixi tree [OPTIONS] [REGEX]
```
## Arguments
- <a id="arg-<REGEX>" href="#arg-<REGEX>">`<REGEX>`</a>
: List only packages matching a regular expression
## Options
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
: The platform to list packages for. Defaults to the current platform
- <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---invert" href="#arg---invert">`--invert (-i)`</a>
: Invert tree and show what depends on given package in the regex argument
## Update Options
- <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`
- <a id="arg---locked" href="#arg---locked">`--locked`</a>
: Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file
<br>**env**: `PIXI_LOCKED`
- <a id="arg---no-install" href="#arg---no-install">`--no-install`</a>
: Don't modify the environment, only modify the lock-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
## Description
Show a tree of workspace dependencies
Dependency names highlighted in green are directly specified in the manifest. Yellow version numbers are conda packages, PyPI version numbers are blue.
--8<-- "docs/reference/cli/pixi/tree_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/pip/html/reference/requirement-specifiers.md:
--------------------------------------------------------------------------------
```markdown
(Requirement Specifiers)=
# Requirement Specifiers
pip supports installing from a package index using a {term}`requirement specifier <pypug:Requirement Specifier>`. Generally speaking, a requirement specifier is composed of a project name followed by optional {term}`version specifiers <pypug:Version Specifier>`.
{pep}`508` contains a full specification of the format of a requirement.
```{versionadded} 6.0
Support for environment markers.
```
```{versionadded} 19.1
Support for the direct URL reference form.
```
## Overview
A requirement specifier comes in two forms:
- name-based, which is composed of:
- a package name (eg: `requests`)
- optionally, a set of "extras" that serve to install optional dependencies (eg: `security`)
- optionally, constraints to apply on the version of the package
- optionally, environment markers
- URL-based, which is composed of:
- a package name (eg: `requests`)
- optionally, a set of "extras" that serve to install optional dependencies (eg: `security`)
- a URL for the package
- optionally, environment markers
## Examples
A few example name-based requirement specifiers:
```
SomeProject
SomeProject == 1.3
SomeProject >= 1.2, < 2.0
SomeProject[foo, bar]
SomeProject ~= 1.4.2
SomeProject == 5.4 ; python_version < '3.8'
SomeProject ; sys_platform == 'win32'
requests [security] >= 2.8.1, == 2.8.* ; python_version < "2.7"
```
```{note}
Use quotes around specifiers in the shell when using `>`, `<`, or when using environment markers.
Do _not_ use quotes in requirement files. There is only one exception: pip v7.0 and v7.0.1 (from May 2015) required quotes around specifiers containing environment markers in requirement files.
```
A few example URL-based requirement specifiers:
```none
pip @ https://github.com/pypa/pip/archive/22.0.2.zip
requests [security] @ https://github.com/psf/requests/archive/refs/heads/main.zip ; python_version >= "3.11"
```
```
--------------------------------------------------------------------------------
/src/assets/uv/concepts/authentication/certificates.md:
--------------------------------------------------------------------------------
```markdown
# TLS certificates
By default, uv loads certificates from the bundled `webpki-roots` crate. The `webpki-roots` are a
reliable set of trust roots from Mozilla, and including them in uv improves portability and
performance (especially on macOS, where reading the system trust store incurs a significant delay).
## System certificates
In some cases, you may want to use the platform's native certificate store, especially if you're
relying on a corporate trust root (e.g., for a mandatory proxy) that's included in your system's
certificate store. To instruct uv to use the system's trust store, run uv with the `--native-tls`
command-line flag, or set the `UV_NATIVE_TLS` environment variable to `true`.
## Custom certificates
If a direct path to the certificate is required (e.g., in CI), set the `SSL_CERT_FILE` environment
variable to the path of the certificate bundle, to instruct uv to use that file instead of the
system's trust store.
If client certificate authentication (mTLS) is desired, set the `SSL_CLIENT_CERT` environment
variable to the path of the PEM formatted file containing the certificate followed by the private
key.
## Insecure hosts
If you're using a setup in which you want to trust a self-signed certificate or otherwise disable
certificate verification, you can instruct uv to allow insecure connections to dedicated hosts via
the `allow-insecure-host` configuration option. For example, adding the following to
`pyproject.toml` will allow insecure connections to `example.com`:
```toml
[tool.uv]
allow-insecure-host = ["example.com"]
```
`allow-insecure-host` expects to receive a hostname (e.g., `localhost`) or hostname-port pair (e.g.,
`localhost:8080`), and is only applicable to HTTPS connections, as HTTP connections are inherently
insecure.
Use `allow-insecure-host` with caution and only in trusted environments, as it can expose you to
security risks due to the lack of certificate verification.
```
--------------------------------------------------------------------------------
/src/assets/pixi/reference/cli/pixi/task/add.md:
--------------------------------------------------------------------------------
```markdown
---
title: pixi task add
---
<!--- This file is autogenerated. Do not edit manually! -->
# [pixi](../../pixi.md) [task](../task.md) add
Add a command to the workspace
--8<-- "docs/reference/cli/pixi/task/add_extender:description"
## Usage
```
pixi task add [OPTIONS] <NAME> <COMMAND>...
```
## Arguments
- <a id="arg-<NAME>" href="#arg-<NAME>">`<NAME>`</a>
: Task name
<br>**required**: `true`
- <a id="arg-<COMMAND>" href="#arg-<COMMAND>">`<COMMAND>`</a>
: One or more commands to actually execute
<br>May be provided more than once.
<br>**required**: `true`
## Options
- <a id="arg---depends-on" href="#arg---depends-on">`--depends-on <DEPENDS_ON>`</a>
: Depends on these other commands
<br>May be provided more than once.
- <a id="arg---platform" href="#arg---platform">`--platform (-p) <PLATFORM>`</a>
: The platform for which the task should be added
- <a id="arg---feature" href="#arg---feature">`--feature (-f) <FEATURE>`</a>
: The feature for which the task should be added
- <a id="arg---cwd" href="#arg---cwd">`--cwd <CWD>`</a>
: The working directory relative to the root of the workspace
- <a id="arg---env" href="#arg---env">`--env <ENV>`</a>
: The environment variable to set, use --env key=value multiple times for more than one variable
<br>May be provided more than once.
- <a id="arg---default-environment" href="#arg---default-environment">`--default-environment <DEFAULT_ENVIRONMENT>`</a>
: Add a default environment for the task
- <a id="arg---description" href="#arg---description">`--description <DESCRIPTION>`</a>
: A description of the task to be added
- <a id="arg---clean-env" href="#arg---clean-env">`--clean-env`</a>
: Isolate the task from the shell environment, and only use the pixi environment to run the task
- <a id="arg---arg" href="#arg---arg">`--arg <ARGS>`</a>
: The arguments to pass to the task
<br>May be provided more than once.
--8<-- "docs/reference/cli/pixi/task/add_extender:example"
```
--------------------------------------------------------------------------------
/src/assets/uv/concepts/authentication/cli.md:
--------------------------------------------------------------------------------
```markdown
# The `uv auth` CLI
uv provides a high-level interface for storing and retrieving credentials from services.
## Logging in to a service
To add credentials for service, use the `uv auth login` command:
```console
$ uv auth login example.com
```
This will prompt for the credentials.
The credentials can also be provided using the `--username` and `--password` options, or the
`--token` option for services which use a `__token__` or arbitrary username.
!!! note
We recommend providing the secret via stdin. Use `-` to indicate the value should be read from
stdin, e.g., for `--password`:
```console
$ echo 'my-password' | uv auth login example.com --password -
```
The same pattern can be used with `--token`.
Once credentials are added, uv will use them for packaging operations that require fetching content
from the given service. At this time, only HTTPS Basic authentication is supported. The credentials
will not yet be used for Git requests.
!!! note
The credentials will not be validated, i.e., incorrect credentials will not fail.
## Logging out of a service
To remove credentials, use the `uv auth logout` command:
```console
$ uv auth logout example.com
```
!!! note
The credentials will not be invalidated with the remote server, i.e., they will only be removed
from local storage not rendered unusable.
## Showing credentials for a service
To show the credential stored for a given URL, use the `uv auth token` command:
```console
$ uv auth token example.com
```
If a username was used to log in, it will need to be provided as well, e.g.:
```console
$ uv auth token --username foo example.com
```
## Configuring the storage backend
Credentials are persisted to the uv [credentials store](./http.md#the-uv-credentials-store).
By default, credentials are written to a plaintext file. An encrypted system-native storage backend
can be enabled with `UV_PREVIEW_FEATURES=native-auth`.
```