Skip to content

Commit 437b63c

Browse files
committed
docs: windows
1 parent ee005ff commit 437b63c

File tree

3 files changed

+41
-15
lines changed

3 files changed

+41
-15
lines changed

docs/faq.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# FAQs
22

3-
## I don't want to put a `.tool-versions` file into my project since git shows it as an untracked file
3+
## I don't want to put a
4+
5+
`.tool-versions` file into my project since git shows it as an untracked file
46

57
You can make git ignore these files in 3 different ways:
68

@@ -26,7 +28,8 @@ While this change is rolling out, there is some migration code that will move in
2628
the "nodejs" and "golang" directories to the new names. If this runs for you you'll see a message
2729
but it should not run again unless there is some kind of problem. In this case, it's probably
2830
easiest to just
29-
run `rm -rf ~/.local/share/mise/installs/{golang,nodejs} ~/.local/share/mise/plugins/{golang,nodejs}`.
31+
run
32+
`rm -rf ~/.local/share/mise/installs/{golang,nodejs} ~/.local/share/mise/plugins/{golang,nodejs}`.
3033

3134
Once most users have migrated over this migration code will be removed.
3235

@@ -134,9 +137,11 @@ setting `MISE_USE_VERSIONS_HOST=0`.
134137

135138
## Windows support?
136139

137-
This is something we'd like to add! <https://github.com/jdx/mise/discussions/66>
140+
Very basic support for windows is currently available, however because Windows can't support asdf
141+
plugins, they must use core and vfox only—which means only a handful of tools are available on
142+
Windows.
138143

139-
It's not a near-term goal and it would require plugin modifications, but it should be feasible.
144+
As of this writing, env var management and task execution are not yet supported on Windows.
140145

141146
## How do I use mise with http proxies?
142147

docs/getting-started.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,6 @@ Supported os/arch:
187187
- `linux-armv7-musl`
188188

189189
If you need something else, compile it with `cargo install mise` (see below).
190-
[Windows isn't currently supported.](https://github.com/jdx/mise/discussions/66)
191190

192191
### apk
193192

@@ -329,6 +328,14 @@ yum-config-manager --add-repo https://mise.jdx.dev/rpm/mise.repo
329328
yum install -y mise
330329
```
331330

331+
### Windows
332+
333+
Download the latest release from [GitHub](https://github.com/jdx/mise/releases). Add the binary
334+
to your PATH and edit PATH to include the shims directory (by default:
335+
`%USERPROFILE%\.local\share\mise\shims`).
336+
337+
Note that Windows support is very minimal for now.
338+
332339
## Shells
333340

334341
### Bash

docs/project-roadmap.md

+24-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# Project Roadmap
22

3-
Issues marked ["enhancements"](https://github.com/jdx/mise/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) are the best way to read about ideas for future
3+
Issues
4+
marked ["enhancements"](https://github.com/jdx/mise/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
5+
are the best way to read about ideas for future
46
functionality. As far as general scope however, these are likely going to be focuses for 2024:
57

6-
* Tasks - this is the newest headline feature of mise and needs to be refined, tested, and iterated on before it can come out of experimental
8+
* Tasks - this is the newest headline feature of mise and needs to be refined, tested, and iterated
9+
on before it can come out of experimental
710
* Documentation website - we've outgrown what is mostly a single README
8-
* Supply chain hardening - securing mise is very important and this topic has had a lot of interest from the community. We plan to make several improvements on this front
9-
* Improved python development - better virtualenv integration, precompiled python binaries, and other areas are topics that frequently come up to improve
10-
* Improved plugin development - it's unclear what we'll do exactly but in general we want to make the experience of vending tools for asdf/mise to be better and safer.
11-
* GUI/TUI - While we're all big CLI fans, it still would be great to better visualize what tools are available, what your configuration is, and other things via some kind of UI.
11+
* Supply chain hardening - securing mise is very important and this topic has had a lot of interest
12+
from the community. We plan to make several improvements on this front
13+
* Improved python development - better virtualenv integration, precompiled python binaries, and
14+
other areas are topics that frequently come up to improve
15+
* Improved plugin development - it's unclear what we'll do exactly but in general we want to make
16+
the experience of vending tools for asdf/mise to be better and safer.
17+
* GUI/TUI - While we're all big CLI fans, it still would be great to better visualize what tools are
18+
available, what your configuration is, and other things via some kind of UI.
1219

1320
## Versioning
1421

@@ -27,7 +34,14 @@ Each release will be small and incremental.
2734

2835
## Anti-goals
2936

30-
* Dependency management - mise expects you to have system dependencies (like openssl or readline) already setup and configured. This makes it different than tools like nix which manage all dependencies for you. While this seems like an obvious downside, it actually ends up making mise far easier to use than nix. That said, we would like to make managing system dependencies easier where we can but this is likely going to be simply via better docs and error messages.
31-
* DevOps tooling - mise is designed with local development in mind. While there are certainly many devs using it for production/server roles which we support and encourage, that will never be the our focus on the roadmap. Building a better ansible/terraform/kubernetes just isn't the goal.
32-
* Remote task caching - turbopack, moonrepo, and many others are trying to solve this (major) problem. mise's task runner will likely always just be a simple convenience around executing scripts.
33-
* Windows support - I don't have a Windows machine and I think asdf/mise's focus on Unix tools will make supporting (non-WSL) Windows challenging if not impossible. Unless someone else wants to take on the challenge of building a Windows port I would not expect to see it happen.
37+
* Dependency management - mise expects you to have system dependencies (like openssl or readline)
38+
already setup and configured. This makes it different than tools like nix which manage all
39+
dependencies for you. While this seems like an obvious downside, it actually ends up making mise
40+
far easier to use than nix. That said, we would like to make managing system dependencies easier
41+
where we can but this is likely going to be simply via better docs and error messages.
42+
* DevOps tooling - mise is designed with local development in mind. While there are certainly many
43+
devs using it for production/server roles which we support and encourage, that will never be the
44+
our focus on the roadmap. Building a better ansible/terraform/kubernetes just isn't the goal.
45+
* Remote task caching - turbopack, moonrepo, and many others are trying to solve this (major)
46+
problem. mise's task runner will likely always just be a simple convenience around executing
47+
scripts.

0 commit comments

Comments
 (0)