From 78bc958905b53a785c9a0a70b27fafae8b11a436 Mon Sep 17 00:00:00 2001 From: Gin <65128789+GinOwO@users.noreply.github.com> Date: Thu, 11 Jul 2024 03:19:55 +0530 Subject: [PATCH] pixi, pixi-{config,global,project,task}: add page (#13249) --- pages/common/pixi-config.md | 28 ++++++++++++++++++++++++++++ pages/common/pixi-global.md | 24 ++++++++++++++++++++++++ pages/common/pixi-project.md | 24 ++++++++++++++++++++++++ pages/common/pixi-task.md | 20 ++++++++++++++++++++ pages/common/pixi.md | 32 ++++++++++++++++++++++++++++++++ 5 files changed, 128 insertions(+) create mode 100644 pages/common/pixi-config.md create mode 100644 pages/common/pixi-global.md create mode 100644 pages/common/pixi-project.md create mode 100644 pages/common/pixi-task.md create mode 100644 pages/common/pixi.md diff --git a/pages/common/pixi-config.md b/pages/common/pixi-config.md new file mode 100644 index 0000000000..5dc8c6835e --- /dev/null +++ b/pages/common/pixi-config.md @@ -0,0 +1,28 @@ +# pixi config + +> Manage the configuration file. +> More information: . + +- Edit the configuration file: + +`pixi config edit` + +- List all configurations: + +`pixi config list` + +- Prepend a value to a list configuration key: + +`pixi config prepend {{key}} {{value}}` + +- Append a value to a list configuration key: + +`pixi config append {{key}} {{value}}` + +- Set a configuration key to a value: + +`pixi config set {{key}} {{value}}` + +- Unset a configuration key: + +`pixi config unset {{key}}` diff --git a/pages/common/pixi-global.md b/pages/common/pixi-global.md new file mode 100644 index 0000000000..a7fb2648c6 --- /dev/null +++ b/pages/common/pixi-global.md @@ -0,0 +1,24 @@ +# pixi global + +> Manage global packages. +> More information: . + +- Install a package globally and add to path: + +`pixi global install {{package1 package2 ...}}` + +- Uninstall a package globally: + +`pixi global remove {{package1 package2 ...}}` + +- List all globally installed packages: + +`pixi global list` + +- Update a globally installed package: + +`pixi global upgrade {{package}}` + +- Update all globally installed packages: + +`pixi global upgrade-all` diff --git a/pages/common/pixi-project.md b/pages/common/pixi-project.md new file mode 100644 index 0000000000..94efb95b16 --- /dev/null +++ b/pages/common/pixi-project.md @@ -0,0 +1,24 @@ +# pixi project + +> Modify the project configuration file. +> More information: . + +- Manage project channels: + +`pixi project channel {{command}}` + +- Manage project description: + +`pixi project description {{command}}` + +- Manage project platform: + +`pixi project platform {{command}}` + +- Manage project version: + +`pixi project version {{command}}` + +- Manage project environment: + +`pixi project environment {{command}}` diff --git a/pages/common/pixi-task.md b/pages/common/pixi-task.md new file mode 100644 index 0000000000..0644b1dd1e --- /dev/null +++ b/pages/common/pixi-task.md @@ -0,0 +1,20 @@ +# pixi task + +> Manage tasks in the project environment. +> More information: . + +- Create a new task: + +`pixi task add {{task_name}} {{task_command}}` + +- List all tasks in the project: + +`pixi task list` + +- Remove a task: + +`pixi task remove {{task_name}}` + +- Create an alias for a task: + +`pixi task alias {{alias_name}} {{task1 task2 ...}}` diff --git a/pages/common/pixi.md b/pages/common/pixi.md new file mode 100644 index 0000000000..1d65dde573 --- /dev/null +++ b/pages/common/pixi.md @@ -0,0 +1,32 @@ +# pixi + +> Developer Workflow and Environment Management for projects. +> More information: . + +- Initialize a new project: + +`pixi init {{path/to/project}}` + +- Add project dependencies: + +`pixi add {{dependency1 dependency2 ...}}` + +- Start a pixi shell in the project environment: + +`pixi shell` + +- Run a task in the project environment: + +`pixi run {{task}}` + +- Manage tasks in the project environment: + +`pixi task {{command}}` + +- Print the help message: + +`pixi {{command}} --help` + +- Clean environment and task cache: + +`pixi clean`