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

flags: move raw+jobs flags to only commands that install #1168

Merged
merged 1 commit into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 65 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1902,9 +1902,18 @@ Options:

[possible values: bash, fish, nu, xonsh, zsh]

-j, --jobs <JOBS>
Number of jobs to run in parallel
[default: 4]

[env: RTX_JOBS=]

-J, --json
Output in JSON format

--raw
Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1

Examples:
$ eval "$(rtx env -s bash)"
$ eval "$(rtx env -s zsh)"
Expand Down Expand Up @@ -1968,6 +1977,15 @@ Options:
-C, --cd <CD>
Change to this directory before executing the command

-j, --jobs <JOBS>
Number of jobs to run in parallel
[default: 4]

[env: RTX_JOBS=]

--raw
Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1

Examples:
$ rtx exec node@20 -- node ./app.js # launch app.js using node-20.x
$ rtx x node@20 -- node ./app.js # shorter alias
Expand Down Expand Up @@ -2018,6 +2036,15 @@ Options:
-f, --force
Force reinstall even if already installed

-j, --jobs <JOBS>
Number of jobs to run in parallel
[default: 4]

[env: RTX_JOBS=]

--raw
Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1

-v, --verbose...
Show installation output

Expand Down Expand Up @@ -2545,6 +2572,15 @@ Arguments:
Tool(s) to use

Options:
-j, --jobs <JOBS>
Number of jobs to run in parallel
[default: 4]

[env: RTX_JOBS=]

--raw
Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1

-u, --unset
Removes a previously set version

Expand Down Expand Up @@ -2669,6 +2705,15 @@ Arguments:
Options:
-n, --dry-run
Just print what would be done, don't actually do it

-j, --jobs <JOBS>
Number of jobs to run in parallel
[default: 4]

[env: RTX_JOBS=]

--raw
Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1
```

### `rtx use [OPTIONS] [TOOL@VERSION]...`
Expand All @@ -2690,29 +2735,41 @@ Arguments:
If no version is specified, it will default to @latest

Options:
--pin
Save exact version to config file
e.g.: `rtx use --pin node@20` will save 20.0.0 as the version

[env: RTX_ASDF_COMPAT=]
-f, --force
Force reinstall even if already installed

--fuzzy
Save fuzzy version to config file
e.g.: `rtx use --fuzzy node@20` will save 20 as the version
this is the default behavior unless RTX_ASDF_COMPAT=1

--remove <TOOL>
Remove the tool(s) from config file

-g, --global
Use the global config file (~/.config/rtx/config.toml) instead of the local one

-e, --env <ENV>
Modify an environment-specific config file like .rtx.<env>.toml

-j, --jobs <JOBS>
Number of jobs to run in parallel
[default: 4]

[env: RTX_JOBS=]

--raw
Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1

--remove <TOOL>
Remove the tool(s) from config file

-p, --path <PATH>
Specify a path to a config file or directory If a directory is specified, it will look for .rtx.toml (default) or .tool-versions

--pin
Save exact version to config file
e.g.: `rtx use --pin node@20` will save 20.0.0 as the version

[env: RTX_ASDF_COMPAT=]

Examples:
# set the current version of node to 20.x in .rtx.toml of current directory
# will write the fuzzy version (e.g.: 20)
Expand Down
Loading
Loading