Skip to content

Commit b57a694

Browse files
chore: add documentation for ./scripts/link
1 parent ccd116d commit b57a694

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,3 +118,23 @@ base64-encoding). Note that absolute paths will begin with `@file://` or
118118
```bash
119119
beeper-desktop-cli <command> --arg @data://file.txt
120120
```
121+
122+
## Linking different Go SDK versions
123+
124+
You can link the CLI against a different version of the Beeper Desktop Go SDK
125+
for development purposes using the `./scripts/link` script.
126+
127+
To link to a specific version from a repository (version can be a branch,
128+
git tag, or commit hash):
129+
130+
```bash
131+
./scripts/link github.com/org/repo@version
132+
```
133+
134+
To link to a local copy of the SDK:
135+
136+
```bash
137+
./scripts/link ../path/to/beeperdesktopapi-go
138+
```
139+
140+
If you run the link script without any arguments, it will default to `../beeperdesktopapi-go`.

0 commit comments

Comments
 (0)