Skip to content

Commit e75cd9d

Browse files
codekilncodekiln
committed
Add new documentation for installing Mise and update journal entries for May 17 and 18, 2025
- Created a new documentation page for installing Mise shell completions in Zsh, detailing the installation process, configuration, and troubleshooting tips. - Added a new documentation page for first-time installation of Mise, outlining setup procedures and common issues. - Updated the May 17, 2025 journal entry to reflect the new documentation links and improve clarity. - Enhanced the May 18, 2025 journal entry by including references to the new installation guides, ensuring users have access to comprehensive resources for Mise.
1 parent 5a9e220 commit e75cd9d

5 files changed

Lines changed: 95 additions & 5 deletions

‎journals/2025_05_17.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- [[mise/Python/How To/Use mise to set up a virtualenv with uv]]
88
- [[Person/Jeff Dickey/GitHub/usage]]
99
- [[mise/How To/List tasks available in zsh]]
10-
- [[mise/How To/Install Mise Shell Completions in Zsh]]
10+
- [[mise/How To/Install Mise/Shell Completions in Zsh]]
1111
- ## #Coding #Term
1212
- #Filed
1313
- [[Linting]]

‎journals/2025_05_18.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
## [[CLI/Craftsmanship]]
2+
- #Filed
3+
- [[mise/How To/Install Mise/The First Time]]
24
- #Updated
3-
- [[mise/Python/How To/Use mise to set up a virtualenv with uv]]
5+
- [[mise/Python/How To/Use mise to set up a virtualenv with uv]]
6+
- [[mise/How To/Install Mise/Shell Completions in Zsh]]

pages/mise___How To___Install Mise Shell Completions in Zsh.md renamed to pages/mise___How To___Install Mise___Shell Completions in Zsh.md

File renamed without changes.

‎pages/mise___How To___Install Mise___The First Time.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
tags:: [[Diataxis/How To]]
2+
3+
- # How to Install Mise for the First Time
4+
- ## Goal
5+
- Install and configure mise, a tool for managing programming language runtimes and development tools.
6+
- ## Preconditions
7+
- A Unix-like operating system (macOS, Linux, or WSL)
8+
- Basic familiarity with the command line
9+
- Git installed (for version control)
10+
- ## Procedure
11+
- ### 1. Install the mise CLI
12+
- Run the following command in your terminal:
13+
- ~~~
14+
curl https://mise.run | sh
15+
~~~
16+
- This will install mise to `~/.local/bin/mise`
17+
- Verify the installation:
18+
- ~~~
19+
~/.local/bin/mise --version
20+
~~~
21+
- If the curl command fails, try downloading the binary directly from [mise releases](https://github.com/jdx/mise/releases)
22+
- ### 2. Choose an Activation Method
23+
- #### Option A: Project-Specific Setup (Recommended for First-Time Users)
24+
- This option is best if you want to try mise with a specific project first
25+
- No shell configuration changes required
26+
- You'll need to prefix commands with `mise exec` or use `mise run`
27+
- Example:
28+
- ~~~
29+
mise exec -- python --version
30+
~~~
31+
- #### Option B: Global Setup (Recommended for Regular Users)
32+
- This option makes mise available system-wide
33+
- Add the following to your shell's configuration file:
34+
- For bash (`~/.bashrc`):
35+
- ~~~
36+
echo 'eval "$(~/.local/bin/mise activate bash)"' >> ~/.bashrc
37+
~~~
38+
- For zsh (`~/.zshrc`):
39+
- ~~~
40+
echo 'eval "$(~/.local/bin/mise activate zsh)"' >> ~/.zshrc
41+
~~~
42+
- For fish (`~/.config/fish/config.fish`):
43+
- ~~~
44+
echo '~/.local/bin/mise activate fish | source' >> ~/.config/fish/config.fish
45+
~~~
46+
- Restart your shell or source your configuration file
47+
- Verify activation:
48+
- ~~~
49+
mise --version
50+
~~~
51+
- ### 3. Configure Your Projects
52+
- Create a `mise.toml` file in your project root to manage tools and tasks
53+
- Basic configuration example:
54+
- ~~~
55+
[tools]
56+
python = "3.13"
57+
node = "20"
58+
59+
[tasks]
60+
test = "pytest"
61+
lint = "ruff check ."
62+
~~~
63+
- For more advanced configuration options, see the [mise configuration guide](https://mise.jdx.dev/configuration.html)
64+
- ## Troubleshooting
65+
- ### Installation Issues
66+
- If the curl command fails, try downloading the binary directly from [mise releases](https://github.com/jdx/mise/releases)
67+
- Ensure `~/.local/bin` is in your PATH
68+
- ### Activation Issues
69+
- If `mise` command is not found after activation:
70+
- Check that the activation line was added correctly to your shell config
71+
- Verify the path to mise binary (`~/.local/bin/mise`)
72+
- Try restarting your shell
73+
- ### Project-Specific Issues
74+
- If mise doesn't pick up project configuration:
75+
- Run `mise config ls` to see which config files are active
76+
- Ensure you're in the project root directory
77+
- Check that your `mise.toml` file is properly formatted
78+
- ## Next Steps
79+
- Learn about [mise configuration](https://mise.jdx.dev/configuration.html)
80+
- Explore [available tools](https://mise.jdx.dev/tools.html)
81+
- Read about [task management](https://mise.jdx.dev/tasks.html)
82+
- ## References
83+
- [Official mise documentation](https://mise.jdx.dev/)
84+
- [mise installation guide](https://mise.jdx.dev/installing-mise.html)
85+
- [mise configuration guide](https://mise.jdx.dev/configuration.html)
86+
- [mise tools guide](https://mise.jdx.dev/tools.html)
87+
- [mise tasks guide](https://mise.jdx.dev/tasks.html)

‎pages/mise___How To___List tasks available in zsh.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ tags:: [[Diataxis/How To]], [[mise]], [[zsh]], [[OhMyZsh]]
22

33
- # How To List Available [[mise/Tasks]] in zsh
44
- ## Overview
5-
- **IMPORTANT NOTE** - If you have followed [[mise/How To/Install Mise Shell Completions in Zsh]], you should be able to just do [[mise/run]] then `tab` and get them autocompleted
5+
- **IMPORTANT NOTE** - If you have followed [[mise/How To/Install Mise/Shell Completions in Zsh]], you should be able to just do [[mise/run]] then `tab` and get them autocompleted
66
- This guide shows you **another** way to list and discover available mise tasks in your zsh shell
77
- For developers who want to see what tasks they can run with `mise run <task-name>`
88
- Includes how to view task descriptions and enable tab completion
@@ -61,7 +61,7 @@ tags:: [[Diataxis/How To]], [[mise]], [[zsh]], [[OhMyZsh]]
6161
- Or use mise's completion system exclusively
6262
- ## Troubleshooting
6363
- If tasks aren't showing up:
64-
- [[mise/How To/Install Mise Shell Completions in Zsh]]
64+
- [[mise/How To/Install Mise/Shell Completions in Zsh]]
6565
- Try running `mise doctor` to check your setup
6666
- If tab completion isn't working:
6767
- Ensure mise is properly activated in your shell
@@ -71,4 +71,4 @@ tags:: [[Diataxis/How To]], [[mise]], [[zsh]], [[OhMyZsh]]
7171
- Make sure mise is in your PATH
7272
- Verify the activation line is in your `~/.zshrc`
7373
- ## Related
74-
- [[mise/How To/Install Mise Shell Completions in Zsh]]
74+
- [[mise/How To/Install Mise/Shell Completions in Zsh]]

0 commit comments

Comments
 (0)