You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The Boot.dev CLI requires an up-to-date Golang installation, and only works on L
16
16
17
17
**Option 1**: [The webi installer](https://webinstall.dev/golang/) is the simplest way for most people. Just run this in your terminal:
18
18
19
-
```bash
19
+
```sh
20
20
curl -sS https://webi.sh/golang | sh
21
21
```
22
22
@@ -38,14 +38,14 @@ Run `go version` on your command line to make sure the installation worked. If i
38
38
39
39
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:
This command will download, build, and install the `bootdev` command into your Go toolchain's `bin` directory. Go ahead and run it:
58
58
59
-
```bash
59
+
```sh
60
60
go install github.com/bootdotdev/bootdev@latest
61
61
```
62
62
@@ -66,14 +66,14 @@ Run `bootdev --version` on your command line to make sure the installation worke
66
66
67
67
If you're getting a "command not found" error for `bootdev help`, it's most likely because the directory containing the `bootdev` 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. You probably need to add `$HOME/go/bin` (the default `GOBIN` directory where `go` installs programs) to your `PATH`:
68
68
69
-
```bash
69
+
```sh
70
70
# For Linux/WSL
71
71
echo'export PATH=$PATH:$HOME/go/bin'>>~/.bashrc
72
72
# next, reload your shell configuration
73
73
source~/.bashrc
74
74
```
75
75
76
-
```bash
76
+
```sh
77
77
# For Mac OS
78
78
echo'export PATH=$PATH:$HOME/go/bin'>>~/.zshrc
79
79
# next, reload your shell configuration
@@ -86,7 +86,7 @@ Run `bootdev login` to authenticate with your Boot.dev account. After authentica
86
86
87
87
## Configuration
88
88
89
-
The Boot.dev CLI offers a couple of configuration options that are stored in a config file (default is `~/.bootdev.yaml`).
89
+
The Boot.dev CLI offers a couple of configuration options that are stored in a config file (default is `~/.bootdev.yaml`, or `$XDG_CONFIG_HOME/bootdev/config.yaml` if `XDG_CONFIG_HOME` is set).
90
90
91
91
All commands have `-h`/`--help` flags if you want to see available options on the command line.
92
92
@@ -96,44 +96,44 @@ For lessons with HTTP tests, you can configure the CLI with a base URL that over
96
96
97
97
- To set the base URL run:
98
98
99
-
```bash
100
-
bootdev config base_url <url>
101
-
```
99
+
```sh
100
+
bootdev config base_url <url>
101
+
```
102
102
103
-
_Make sure you include the protocol scheme (`http://`) in the URL._
103
+
_Make sure you include the protocol scheme (`http://`) in the URL._
104
104
105
105
- To get the current base URL (the default is an empty string), run:
106
106
107
-
```bash
108
-
bootdev config base_url
109
-
```
107
+
```sh
108
+
bootdev config base_url
109
+
```
110
110
111
111
- To reset the base URL and revert to using the lessons' defaults, run:
112
112
113
-
```bash
114
-
bootdev config base_url --reset
115
-
```
113
+
```sh
114
+
bootdev config base_url --reset
115
+
```
116
116
117
117
### CLI colors
118
118
119
119
The CLI text output is rendered with extra colors: green (e.g., success messages), red (e.g., error messages), and gray (e.g., secondary text).
0 commit comments