Skip to content

Commit

Permalink
Commit from GitHub Actions (rtx)
Browse files Browse the repository at this point in the history
  • Loading branch information
jdx committed Dec 7, 2023
1 parent 860f614 commit 755b84a
Showing 1 changed file with 42 additions and 42 deletions.
84 changes: 42 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1696,7 +1696,7 @@ Examples:
### `rtx alias set <PLUGIN> <ALIAS> <VALUE>`

```
```text
Add/update an alias for a plugin
This modifies the contents of ~/.config/rtx/config.toml
Expand All @@ -1719,7 +1719,7 @@ Examples:

### `rtx alias unset <PLUGIN> <ALIAS>`

```
```text
Clears an alias for a plugin
This modifies the contents of ~/.config/rtx/config.toml
Expand All @@ -1739,23 +1739,23 @@ Examples:

### `rtx bin-paths`

```
```text
List all the active runtime bin paths
Usage: bin-paths
```

### `rtx cache clear`

```
```text
Deletes all cache files in rtx
Usage: cache clear
```

### `rtx completion [SHELL]`

```
```text
Generate shell completions
Usage: completion [SHELL]
Expand All @@ -1774,7 +1774,7 @@ Examples:

### `rtx current [PLUGIN]`

```
```text
Shows current active and installed runtime versions
This is similar to `rtx ls --current`, but this only shows the runtime
Expand Down Expand Up @@ -1804,7 +1804,7 @@ Examples:

### `rtx deactivate`

```
```text
Disable rtx for current shell session
This can be used to temporarily disable rtx in a shell session.
Expand All @@ -1820,7 +1820,7 @@ Examples:

### `rtx direnv activate`

```
```text
Output direnv function to use rtx inside direnv
See https://github.com/jdx/rtx#direnv for more information
Expand All @@ -1839,7 +1839,7 @@ Examples:

### `rtx doctor`

```
```text
Check rtx installation for possible problems.
Usage: doctor
Expand All @@ -1851,7 +1851,7 @@ Examples:

### `rtx env [OPTIONS] [TOOL@VERSION]...`

```
```text
Exports env vars to activate rtx a single time
Use this if you don't want to permanently install rtx. It's not necessary to
Expand Down Expand Up @@ -1881,7 +1881,7 @@ Examples:

### `rtx env-vars [OPTIONS] [ENV_VARS]...`

```
```text
Manage environment variables
By default this command modifies ".rtx.toml" in the current directory.
Expand All @@ -1908,7 +1908,7 @@ Options:

### `rtx exec [OPTIONS] [TOOL@VERSION]... [-- <COMMAND>...]`

```
```text
Execute a command with tool(s) set
use this to avoid modifying the shell session or running ad-hoc commands with rtx tools set.
Expand Down Expand Up @@ -1948,7 +1948,7 @@ Examples:

### `rtx implode [OPTIONS]`

```
```text
Removes rtx CLI and all related data
Skips config directory by default.
Expand All @@ -1965,7 +1965,7 @@ Options:

### `rtx install [OPTIONS] [TOOL@VERSION]...`

```
```text
Install a tool version
This will install a tool version to `~/.local/share/rtx/installs/<PLUGIN>/<VERSION>`
Expand Down Expand Up @@ -1997,7 +1997,7 @@ Examples:

### `rtx latest [OPTIONS] <TOOL@VERSION>`

```
```text
Gets the latest available version for a plugin
Usage: latest [OPTIONS] <TOOL@VERSION>
Expand All @@ -2020,7 +2020,7 @@ Examples:

### `rtx link [OPTIONS] <TOOL@VERSION> <PATH>`

```
```text
Symlinks a tool version into rtx
Use this for adding installs either custom compiled outside
Expand Down Expand Up @@ -2053,7 +2053,7 @@ Examples:

### `rtx ls [OPTIONS] [PLUGIN]`

```
```text
List installed and/or currently selected tool versions
Usage: ls [OPTIONS] [PLUGIN]
Expand Down Expand Up @@ -2109,7 +2109,7 @@ Examples:

### `rtx ls-remote [OPTIONS] [TOOL@VERSION] [PREFIX]`

```
```text
List runtime versions available for install
note that the results are cached for 24 hours
Expand Down Expand Up @@ -2145,7 +2145,7 @@ Examples:

### `rtx outdated [TOOL@VERSION]...`

```
```text
Shows outdated tool versions
Usage: outdated [TOOL@VERSION]...
Expand All @@ -2169,7 +2169,7 @@ Examples:

### `rtx plugins install [OPTIONS] [NEW_PLUGIN] [GIT_URL]`

```
```text
Install a plugin
note that rtx automatically can install plugins when you install a tool
Expand Down Expand Up @@ -2217,7 +2217,7 @@ Examples:

### `rtx plugins link [OPTIONS] <NAME> [PATH]`

```
```text
Symlinks a plugin into rtx
This is used for developing a plugin.
Expand Down Expand Up @@ -2247,7 +2247,7 @@ Examples:

### `rtx plugins ls [OPTIONS]`

```
```text
List installed plugins
Can also show remotely available plugins to install.
Expand Down Expand Up @@ -2285,7 +2285,7 @@ Examples:

### `rtx plugins ls-remote [OPTIONS]`

```
```text
List all available remote plugins
The full list is here: https://github.com/jdx/rtx/blob/main/src/default_shorthands.rs
Expand All @@ -2306,7 +2306,7 @@ Options:

### `rtx plugins uninstall [OPTIONS] [PLUGIN]...`

```
```text
Removes a plugin
Usage: plugins uninstall [OPTIONS] [PLUGIN]...
Expand All @@ -2328,7 +2328,7 @@ Examples:

### `rtx plugins update [PLUGIN]...`

```
```text
Updates a plugin to the latest version
note: this updates the plugin itself, not the runtime versions
Expand All @@ -2347,7 +2347,7 @@ Examples:

### `rtx prune [OPTIONS] [PLUGIN]...`

```
```text
Delete unused versions of tools
rtx tracks which config files have been used in ~/.local/share/rtx/tracked_config_files
Expand All @@ -2373,7 +2373,7 @@ Examples:

### `rtx reshim`

```
```text
rebuilds the shim farm
This creates new shims in ~/.local/share/rtx/shims for CLIs that have been added.
Expand All @@ -2400,7 +2400,7 @@ Examples:

### `rtx self-update [OPTIONS] [VERSION]`

```
```text
Updates rtx itself
Uses the GitHub Releases API to find the latest release and binary
Expand All @@ -2425,7 +2425,7 @@ Options:

### `rtx settings get <KEY>`

```
```text
Show a current setting
This is the contents of a single entry in ~/.config/rtx/config.toml
Expand All @@ -2446,7 +2446,7 @@ Examples:

### `rtx settings ls`

```
```text
Show current settings
This is the contents of ~/.config/rtx/config.toml
Expand All @@ -2463,7 +2463,7 @@ Examples:

### `rtx settings set <KEY> <VALUE>`

```
```text
Add/update a setting
This modifies the contents of ~/.config/rtx/config.toml
Expand All @@ -2483,7 +2483,7 @@ Examples:

### `rtx settings unset <KEY>`

```
```text
Clears a setting
This modifies the contents of ~/.config/rtx/config.toml
Expand All @@ -2500,7 +2500,7 @@ Examples:

### `rtx shell [OPTIONS] [TOOL@VERSION]...`

```
```text
Sets a tool version for the current shell session
Only works in a session where rtx is already activated.
Expand All @@ -2523,7 +2523,7 @@ Examples:

### `rtx sync node <--brew|--nvm|--nodenv>`

```
```text
Symlinks all tool versions from an external tool into rtx
For example, use this to import all Homebrew node installs into rtx
Expand All @@ -2548,7 +2548,7 @@ Examples:

### `rtx sync python --pyenv`

```
```text
Symlinks all tool versions from an external tool into rtx
For example, use this to import all pyenv installs into rtx
Expand All @@ -2567,7 +2567,7 @@ Examples:

### `rtx trust [OPTIONS] [CONFIG_FILE]`

```
```text
Marks a config file as trusted
This means rtx will parse the file with potentially dangerous
Expand Down Expand Up @@ -2598,7 +2598,7 @@ Examples:

### `rtx uninstall [OPTIONS] <TOOL@VERSION>...`

```
```text
Removes runtime versions
Usage: uninstall [OPTIONS] <TOOL@VERSION>...
Expand All @@ -2622,7 +2622,7 @@ Examples:

### `rtx upgrade [OPTIONS] [TOOL@VERSION]...`

```
```text
Upgrades outdated tool versions
Usage: upgrade [OPTIONS] [TOOL@VERSION]...
Expand All @@ -2640,7 +2640,7 @@ Options:

### `rtx use [OPTIONS] [TOOL@VERSION]...`

```
```text
Change the active version of a tool locally or globally.
This will install the tool if it is not already installed.
Expand Down Expand Up @@ -2698,15 +2698,15 @@ Examples:

### `rtx version`

```
```text
Show rtx version
Usage: version
```

### `rtx where <TOOL@VERSION>`

```
```text
Display the installation path for a runtime
Must be installed.
Expand Down Expand Up @@ -2735,7 +2735,7 @@ Examples:

### `rtx which [OPTIONS] <BIN_NAME>`

```
```text
Shows the path that a bin name points to
Usage: which [OPTIONS] <BIN_NAME>
Expand Down

0 comments on commit 755b84a

Please sign in to comment.