Skip to content

docs(config): clarify always_keep_download behavior #9235

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
Apr 18, 2026
Merged

docs(config): clarify always_keep_download behavior #9235

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,8 @@ python = ['3.10', '3.11']
# for example, .nvmrc in the case of node's nvm
idiomatic_version_file_enable_tools = ['node']

# configure `mise install` to always keep the downloaded archive
always_keep_download = false # deleted after install by default
# keep downloaded archive/source files for debugging
always_keep_download = false # deleted after install; not a cache
always_keep_install = false # deleted on failure by default

# configure how frequently (in minutes) to fetch updated plugin repository changes
Expand Down
7 changes: 5 additions & 2 deletions docs/directories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,11 @@ doing so.

### `~/.local/share/mise/downloads`

This is where plugins may optionally cache downloaded assets such as tarballs. Use the
`always_keep_downloads` setting to prevent mise from removing files from here.
This is where plugins may write downloaded assets such as tarballs during installation. mise removes these files by
default after install/uninstall; set `always_keep_download` to keep them for debugging backend/plugin install behavior.
This directory is not a supported download cache. Some backends may skip a download when the expected file already exists,
but that behavior is backend-specific and not guaranteed. Cache `~/.local/share/mise/installs` instead if you want to
avoid reinstalling tools in CI or offline workflows.

### `~/.local/share/mise/plugins`

Expand Down
2 changes: 1 addition & 1 deletion schema/mise.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@
"type": "boolean"
},
"always_keep_download": {
"description": "should mise keep downloaded files after installation",
"description": "keep downloaded files after installation for debugging",
"type": "boolean"
},
"always_keep_install": {
Expand Down
10 changes: 9 additions & 1 deletion settings.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,15 @@ env = "MISE_ALL_COMPILE"
type = "Bool"

[always_keep_download]
description = "should mise keep downloaded files after installation"
description = "keep downloaded files after installation for debugging"
docs = """
Keeps downloaded archive/source files under `~/.local/share/mise/downloads` after install/uninstall so you can inspect them
while debugging backend/plugin install behavior.

This is not a supported download cache. Some backends may skip a download when the expected file already exists, but that
behavior is backend-specific and not guaranteed. Cache `~/.local/share/mise/installs` instead if you want to avoid
reinstalling tools in CI or offline workflows.
"""
env = "MISE_ALWAYS_KEEP_DOWNLOAD"
type = "Bool"

Expand Down
Loading