Skip to content

docs: fixed toml issues in URL replacements settings documentation #6269

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.

Sign up for GitHub

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

Merged
jdx merged 1 commit into from
Sep 11, 2025
Merged

docs: fixed toml issues in URL replacements settings documentation #6269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 17 additions & 29 deletions docs/url-replacements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,27 @@ URL replacements allow you to modify or redirect any URL that mise attempts to a

## Configuration Examples

Environment variable (JSON format):
```bash
# Simple hostname replacement
export MISE_URL_REPLACEMENTS='
{
"github.com": "nexus.mycompany.net",
"releases.hashicorp.com": "artifactory.xmpl.com"
}'

# Regex pattern (note the escaped backslashes in JSON)
export MISE_URL_REPLACEMENTS='
{
"regex:^http://(.+)" = "https://$1",
"regex:https://github\.com/([^/]+)/([^/]+)/releases/download/(.+)":
"https://hub.corp.com/artifactory/github/$1/$2/$3"
}'
```
In mise.toml (single line):

In mise.toml:
```toml
[settings]
# Simple hostname replacement
url_replacements = {
"github.com" = "nexus.mycompany.net",
"releases.hashicorp.com" = "artifactory.xmpl.com"
}
url_replacements = { "github.com" = "nexus.mycompany.net" }
```

# Regex patterns
url_replacements = {
"regex:^http://(.+)" = "https://$1",
"regex:https://github\\.com/([^/]+)/([^/]+)/releases/download/(.+)" =
"https://hub.corp.com/artifactory/github/$1/$2/$3"
}
In mise.toml (multiline):

```toml
[settings.url_replacements]
"github.com" = "nexus.mycompany.net"
"releases.hashicorp.com" = "artifactory.xmpl.com"
```

RegEx example:

```toml
[settings.url_replacements]
"regex:^http://(.+)" = "https://$1"
"regex:https://github\\.com/([^/]+)/([^/]+)/releases/download/(.+)" = "https://hub.corp.com/artifactory/github/$1/$2/$3"
```

## Simple Hostname Replacement
Expand Down
Loading