Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify in CLI that run can also take commands #1368

Merged
merged 1 commit into from May 13, 2024

Conversation

twrightsman
Copy link
Contributor

I didn't realize pixi run could also execute arbitrary commands in an environment and thought only pre-defined tasks, based on the CLI help text. This small patch makes this a little clearer for folks not reading the online manual.

@twrightsman twrightsman changed the title Clarify in CLI that run can also take commands docs: clarify in CLI that run can also take commands May 10, 2024
@tdejager
Copy link
Contributor

Thanks! Do you think command covers the terminology you expected or something like system command/executable in environment make sense?

@twrightsman
Copy link
Contributor Author

Good question @tdejager . I think something more along the lines of "The predefined pixi task or ad-hoc shell command you want to run in the project's environment" would be most explicit for me. How does that sound?

@ruben-arts
Copy link
Contributor

The only thing to keep in mind is that you run it in the denk task shell, so only commands in that set can be run. E.g. not test like in bash.

So perhaps "ad-hoc task command" would fit better with the implementation.

@twrightsman
Copy link
Contributor Author

Ah, I see. Then perhaps:

The pixi task or a deno task shell command you want to run in the project's environment, which can be an executable in the environment's PATH.

This follows more closely to what the online docs say. I wouldn't necessarily expect a user to know what a "deno task shell" is in order to understand they can execute binaries in the environment with pixi run 🙂

@tdejager
Copy link
Contributor

Sounds good, let's give it a try!

@ruben-arts ruben-arts merged commit cea28f7 into prefix-dev:main May 13, 2024
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants