Skip to content

Commit 053da2b

Browse files
authored
add troubleshooting and TOC to readme (#170)
1 parent 7314511 commit 053da2b

1 file changed

Lines changed: 73 additions & 0 deletions

File tree

README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ This is the official command line tool for [Boot.dev](https://www.boot.dev/). It
88

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

11+
## Table of Contents
12+
13+
- [Installation](#installation)
14+
- [1. Install Go](#1-install-go)
15+
- [2. Install the Boot.dev CLI](#2-install-the-bootdev-cli)
16+
- [3. Login to the CLI](#3-login-to-the-cli)
17+
- [Configuration](#configuration)
18+
- [Base URL for HTTP tests](#base-url-for-http-tests)
19+
- [CLI colors](#cli-colors)
20+
- [Troubleshooting the Config](#troubleshooting-the-config)
21+
- [Upgrading](#upgrading)
22+
- [Troubleshooting Upgrading](#troubleshooting-upgrading)
23+
1124
## Installation
1225

1326
### 1. Install Go
@@ -140,3 +153,63 @@ The CLI text output is rendered with extra colors: green (e.g., success messages
140153
```sh
141154
bootdev config colors --reset
142155
```
156+
157+
### Troubleshooting the Config
158+
159+
If you want to undo changes to your configuration, simply remove it to reset it completely. The CLI will automatically create a fresh config file in the original location. Then login again.
160+
161+
## Upgrading
162+
163+
If you just installed the CLI, it's already upgraded!
164+
165+
The Boot.dev CLI is regularly updated to enhance and expand its features and integration with the web app.
166+
167+
The CLI automatically detects new versions and will require you to upgrade it before submitting or logging in.
168+
169+
To upgrade, run:
170+
171+
```sh
172+
bootdev upgrade
173+
```
174+
175+
or use `go install` with the [latest tagged version](https://github.com/bootdotdev/bootdev/tags):
176+
177+
```sh
178+
go install github.com/bootdotdev/bootdev@v1.28.0
179+
```
180+
181+
### Troubleshooting Upgrading
182+
183+
**1. Bypass the proxy:**
184+
185+
If you keep getting the same upgrade message, you may be pulling from an old cache.
186+
187+
```sh
188+
GOPROXY=direct go install github.com/bootdotdev/bootdev@v1.28.0
189+
```
190+
191+
**2. Re-Install**
192+
193+
If that doesn't work, try a fresh install:
194+
195+
1. Locate the binary file:
196+
197+
```sh
198+
which bootdev
199+
```
200+
201+
2. Carefully remove the binary file after confirming the path is correct:
202+
203+
```sh
204+
rm "$(which bootdev)"
205+
```
206+
207+
3. Confirm the binary is gone. It could be installed in multiple locations.
208+
209+
```sh
210+
which bootdev
211+
```
212+
213+
4. Clean install
214+
215+
Repeat the steps you used to install the CLI. See [Installation](#installation). Then login again.

0 commit comments

Comments
 (0)