Skip to content

Commit 99bfebc

Browse files
update installation instructions for Windows
1 parent 885f9de commit 99bfebc

File tree

1 file changed

+33
-34
lines changed

1 file changed

+33
-34
lines changed

README.md

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,63 +2,62 @@
22
<img src="https://github.com/bootdotdev/bootdev/assets/4583705/7a1184f1-bb43-45fa-a363-f18f8309056f" />
33
</p>
44

5-
# Bootdev CLI
5+
# Boot.dev CLI
66

7-
The official command line tool for [Boot.dev](https://www.boot.dev). It allows you to submit lessons and do other such nonsense.
7+
This is the official command line tool for [Boot.dev](https://www.boot.dev/). It allows you to submit lessons and do other such nonsense.
88

99
⭐ Hit the repo with a star if you're enjoying Boot.dev ⭐
1010

1111
## Installation
1212

1313
### 1. Install Go
1414

15-
The Boot.dev CLI requires an up-to-date Golang installation, and only works on Linux and Mac. If you're on Windows, you'll need to use WSL. Make sure you install go in your Linux/WSL terminal, not your Windows terminal/UI. There are two options:
15+
To use the Boot.dev CLI, you need an up-to-date Golang toolchain installed on your system.
1616

17-
**Option 1**: [The webi installer](https://webinstall.dev/golang/) is the simplest way for most people. Just run this in your terminal:
17+
Please note, the overwhelming majority of our courses that use this CLI are designed to be completed on Linux or macOS – or on Linux-in-Windows via WSL. If you're on Windows, _usually_ what you'll want is to go into WSL and follow Linux installation instructions. However, we now have [at least one course](https://www.boot.dev/courses/learn-data-visualization-power-bi) that is Windows-native. So there are also Windows/PowerShell installation instructions below. Just be aware of which platform you're actually using!
18+
19+
There are two main installation methods that we recommend:
20+
21+
**Option 1 (Linux/WSL/macOS):** The [Webi installer](https://webinstall.dev/golang/) is the simplest way for most people. Just run this in your terminal:
1822

1923
```sh
20-
# for linux/mac
2124
curl -sS https://webi.sh/golang | sh
22-
23-
# for windows
24-
curl.exe https://webi.ms/golang | powershell
2525
```
2626

2727
_Read the output of the command and follow any instructions._
2828

29-
**Option 2**: Use the [official installation instructions](https://go.dev/doc/install).
29+
**Option 2 (any platform, including Windows/PowerShell):** Use the [official Golang installation instructions](https://go.dev/doc/install). On Windows, this means downloading and running a `.msi` installer package; the rest should be taken care of automatically.
3030

31-
Run `go version` on your command line to make sure the installation worked. If it did, _move on to step 2_.
31+
After installing Golang, _open a new shell session_ and run `go version` to make sure everything works. If it does, _move on to step 2_.
3232

3333
**Optional troubleshooting:**
3434

35-
- If you already had Go installed with webi, you should be able to run the same webi command to update it.
36-
- If you already had a version of Go installed a different way, you can use `which go` to find out where it is installed, and remove the old version manually.
35+
- If you already had Go installed with Webi, you should be able to run the same Webi command to update it.
36+
- If you already had a version of Go installed a different way, on Linux/macOS you can run `which go` to find out where it's installed, and (if needed) remove the old version manually. (In PowerShell on Windows, the equivalent is `Get-Command go`.)
3737
- If you're getting a "command not found" error after installation, it's most likely because the directory containing the `go` program isn't in your [`PATH`](https://opensource.com/article/17/6/set-path-linux). You need to add the directory to your `PATH` by modifying your shell's configuration file. First, you need to know _where_ the `go` command was installed. It might be in:
38+
- `~/.local/opt/go/bin` (Webi)
39+
- `/usr/local/go/bin` (official installation)
40+
- Somewhere else?
3841

39-
- `~/.local/opt/go/bin` (webi)
40-
- `/usr/local/go/bin` (official installation)
41-
- Somewhere else?
42-
43-
You can ensure it exists by attempting to run `go` using its full filepath. For example, if you think it's in `~/.local/opt/go/bin`, you can run `~/.local/opt/go/bin/go version`. If that works, then you just need to add `~/.local/opt/go/bin` to your `PATH` and reload your shell:
42+
You can ensure that the program exists by attempting to run `go` using its full filepath. For example, if you think it's in `~/.local/opt/go/bin`, you can run `~/.local/opt/go/bin/go version`. If that works, then you just need to add `~/.local/opt/go/bin` to your `PATH` and reload your shell:
4443

45-
```sh
46-
# For Linux/WSL
47-
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.bashrc
48-
# next, reload your shell configuration
49-
source ~/.bashrc
50-
```
44+
```sh
45+
# For Linux/WSL
46+
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.bashrc
47+
# Next, reload your shell configuration
48+
source ~/.bashrc
49+
```
5150

52-
```sh
53-
# For Mac OS
54-
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.zshrc
55-
# next, reload your shell configuration
56-
source ~/.zshrc
57-
```
51+
```sh
52+
# For macOS
53+
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.zshrc
54+
# Next, reload your shell configuration
55+
source ~/.zshrc
56+
```
5857

5958
### 2. Install the Boot.dev CLI
6059

61-
This command will download, build, and install the `bootdev` command into your Go toolchain's `bin` directory. Go ahead and run it:
60+
The following command will download, build, and install the `bootdev` command into your Go toolchain's `bin` directory. Go ahead and run it:
6261

6362
```sh
6463
go install github.com/bootdotdev/bootdev@latest
@@ -73,14 +72,14 @@ If you're getting a "command not found" error for `bootdev help`, it's most like
7372
```sh
7473
# For Linux/WSL
7574
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.bashrc
76-
# next, reload your shell configuration
75+
# Next, reload your shell configuration
7776
source ~/.bashrc
7877
```
7978

8079
```sh
81-
# For Mac OS
80+
# For macOS
8281
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.zshrc
83-
# next, reload your shell configuration
82+
# Next, reload your shell configuration
8483
source ~/.zshrc
8584
```
8685

@@ -98,7 +97,7 @@ All commands have `-h`/`--help` flags if you want to see available options on th
9897

9998
For lessons with HTTP tests, you can configure the CLI with a base URL that overrides any lesson's default. A common use case for that is when you want to run your server on a port other than the one specified in the lesson.
10099

101-
- To set the base URL run:
100+
- To set the base URL, run:
102101

103102
```sh
104103
bootdev config base_url <url>

0 commit comments

Comments
 (0)