docs: Add "basic idea" overview to basic usage#5881
docs: Add "basic idea" overview to basic usage#5881rafetgns wants to merge 6 commits intoprefix-dev:mainfrom
Conversation
| The following commands interact with these files in sequence: | ||
| - [`pixi add`](./reference/cli/pixi/add.md) - adds a dependency to `pixi.toml` | ||
| - [`pixi lock`](./reference/cli/pixi/lock.md) - resolves the dependencies in `pixi.toml` and writes the exact versions to `pixi.lock` | ||
| - [`pixi install`](./reference/cli/pixi/install.md) - installs the packages listed in `pixi.lock` into the `.pixi/` directory | ||
| - [`pixi run`](./reference/cli/pixi/run.md) - activates the `.pixi/` environment and runs given command |
There was a problem hiding this comment.
I've always struggled with explaining this. But Pixi will install the environment on add/update/install/run/shell/etc. in the same way. So pixi install is only a user command that you "could" run but would never need to get the environment installed as the other commands will make sure the environment is always there.
Did you know that? And would that info change how this is written for a user?
There was a problem hiding this comment.
thanks for pointing that out I actually didn't realize it handled it automatically across all those commands. this changes how we should present it so users don't think running pixi install manually is a strict requirement. I can update the text right now to clarify that pixi auto-installs in background
There was a problem hiding this comment.
Please! Phrasing this correctly for new users is very important to me as I know this mechanism to well to explain it to a new commer.
There was a problem hiding this comment.
It should look better right now
Co-authored-by: Ruben Arts <ruben.arts@pm.me>
| - [`pixi install`](./reference/cli/pixi/install.md) - installs the packages listed in `pixi.lock` into the `.pixi/` directory | ||
| - [`pixi run`](./reference/cli/pixi/run.md) - activates the `.pixi/` environment and runs given command | ||
|
|
||
| You rarely need to run these commands manually. pixi run, pixi shell, and pixi add will automatically update the lockfile and install the environment if anything is missing or out of date. |
There was a problem hiding this comment.
Hmm, now you first list a few commands as most important and then say that some of them should rarely be needed. I'm not sure that clarifies it properly. I don't mind the initial list. Maybe that's just enough then?
There was a problem hiding this comment.
yeah good point actually the extra sentence doesnt add anything and creates confusion by telling people to ignore some of the commands they just listed. i will remove the last sentence and let the list speak for itself.
Co-authored-by: Ruben Arts <ruben.arts@pm.me>
2 participants
Description
Added a high level overview explaining the relationship between pixi.toml, pixi.lock and .pixi/ as well as the commands interacting with those.
Fixes #3383
How Has This Been Tested?
Built locally and tested as preview.
Checklist: