Skip to content

Commit dc0fd28

Browse files
chore: update documentation in readme
1 parent c957b31 commit dc0fd28

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,31 @@ brew install stl
2121

2222
### Installing with Go
2323

24+
To test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed.
25+
2426
```sh
2527
go install 'github.com/stainless-api/stainless-api-cli/cmd/stl@latest'
2628
```
2729

30+
Once you have run `go install`, the binary is placed in your Go bin directory:
31+
32+
- **Default location**: `$HOME/go/bin` (or `$GOPATH/bin` if GOPATH is set)
33+
- **Check your path**: Run `go env GOPATH` to see the base directory
34+
35+
If commands aren't found after installation, add the Go bin directory to your PATH:
36+
37+
```sh
38+
# Add to your shell profile (.zshrc, .bashrc, etc.)
39+
export PATH="$PATH:$(go env GOPATH)/bin"
40+
```
41+
2842
<!-- x-release-please-end -->
2943

3044
### Running Locally
3145

46+
After cloning the git repository for this project, you can use the
47+
`scripts/run` script to run the tool locally:
48+
3249
```sh
3350
./scripts/run args...
3451
```

0 commit comments

Comments
 (0)