Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixes #950
  • Loading branch information
jdx authored Oct 20, 2023
1 parent 2cebe1e commit 6aa2382
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,24 @@ _Note: `env_file` goes at the top of the file, above `[env]`._
NODE_ENV = false # unset a previously set NODE_ENV
```

#### `[plugins]` - Specify Custom Plugin Repo URLs

Use `[plugins]` to add/modify plugin shortnames. Note that this will only modify
*new* plugin installations. Existing plugins can use any URL.

```toml
[plugins]
elixir = "https://github.com/my-org/rtx-elixir.git"
node = "https://github.com/my-org/rtx-node.git#DEADBEEF" # supports specific gitref
```

If you simply want to install a plugin from a specific URL once, it's better to use
`rtx plugin install plugin <GIT_URL>`. Add this section to `.rtx.toml` if you want
to share the plugin location/revision with other developers in your project.

This is similar to [`RTX_SHORTHANDS`](https://github.com/jdx/rtx#rtx_shorthands_fileconfigrtxshorthandstoml)
but doesn't require a separate file.

### Legacy version files

rtx supports "legacy version files" just like asdf. They're language-specific files like `.node-version`
Expand Down

0 comments on commit 6aa2382

Please sign in to comment.