Skip to content

Commit 277ec11

Browse files
committed
Drop GitHub install path and document local link workflow
1 parent 4ca50dc commit 277ec11

4 files changed

Lines changed: 301 additions & 150 deletions

File tree

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,30 @@ Output format is documented in [API.md](./API.md).
1515

1616
## Install
1717

18-
Global install from GitHub (short-term distribution):
18+
For now, install from a local checkout:
1919

2020
```bash
21-
npm install -g github:PSPDFKit-labs/buildkite-cli#v0.0.6
21+
git clone https://github.com/PSPDFKit-labs/buildkite-cli ~/Work/buildkite-cli
22+
cd ~/Work/buildkite-cli
23+
pnpm install
24+
pnpm run build
25+
npm link
2226
bkci --help
2327
```
2428

25-
You can also pin to a commit SHA if needed.
29+
After pulling new changes, rebuild:
30+
31+
```bash
32+
pnpm run build
33+
```
2634

2735
Local development:
2836

2937
```bash
30-
pnpm install
31-
pnpm run build
3238
pnpm run test
3339
```
3440

35-
Run from source:
41+
Run directly without linking:
3642

3743
```bash
3844
node dist/index.js <command>

bin/bkci.js

Lines changed: 0 additions & 26 deletions
This file was deleted.

package.json

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,21 @@
55
"private": true,
66
"type": "module",
77
"bin": {
8-
"bkci": "./bin/bkci.js"
8+
"bkci": "./dist/index.js"
99
},
1010
"scripts": {
1111
"build": "tsc -p tsconfig.json",
12-
"dev": "ts-node-esm src/index.ts",
12+
"dev": "tsx src/index.ts",
1313
"check": "tsc --noEmit -p tsconfig.json",
1414
"test": "pnpm run build && node --test dist/**/*.test.js"
1515
},
1616
"engines": {
1717
"node": ">=20.0.0"
1818
},
1919
"packageManager": "pnpm@9.15.9",
20-
"dependencies": {
21-
"ts-node": "^10.9.2",
22-
"typescript": "^5.9.0"
23-
},
2420
"devDependencies": {
25-
"@types/node": "^24.0.0"
21+
"@types/node": "^24.0.0",
22+
"tsx": "^4.20.0",
23+
"typescript": "^5.9.0"
2624
}
2725
}

0 commit comments

Comments
 (0)