docs

jdx · Feb 8, 2024 · e291cc3 · e291cc3
1 parent e2845f3
commit e291cc3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/cli-reference.md b/docs/cli-reference.md
@@ -1117,6 +1117,10 @@ Sets a tool version for the current session
 
 Only works in a session where mise is already activated.
 
+This works by setting environment variables for the current shell session
+such as `MISE_NODE_VERSION=20` which is "eval"ed as a shell function created
+by `mise activate`.
+
 Usage: shell [OPTIONS] [TOOL@VERSION]...
 
 Arguments:

diff --git a/src/cli/shell.rs b/src/cli/shell.rs
@@ -9,6 +9,10 @@ use crate::toolset::{InstallOptions, ToolSource, ToolsetBuilder};
 /// Sets a tool version for the current session
 ///
 /// Only works in a session where mise is already activated.
+///
+/// This works by setting environment variables for the current shell session
+/// such as `MISE_NODE_VERSION=20` which is "eval"ed as a shell function created
+/// by `mise activate`.
 #[derive(Debug, clap::Args)]
 #[clap(verbatim_doc_comment, visible_alias = "sh", after_long_help = AFTER_LONG_HELP)]
 pub struct Shell {