Skip to content

Commit 81eda45

Browse files
committed
Enable GitHub global install via prepare script
1 parent 91ae941 commit 81eda45

2 files changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

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

1616
## Install
1717

18+
Global install from GitHub (short-term distribution):
19+
20+
```bash
21+
npm install -g github:PSPDFKit-labs/buildkite-cli#main
22+
bkci --help
23+
```
24+
25+
For reproducible installs, pin a tag or commit instead of `#main`.
26+
27+
Local development:
28+
1829
```bash
1930
pnpm install
2031
pnpm run build
2132
pnpm run test
2233
```
2334

24-
Run:
35+
Run from source:
2536

2637
```bash
2738
node dist/index.js <command>

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
},
1010
"scripts": {
1111
"build": "tsc -p tsconfig.json",
12+
"prepare": "pnpm run build",
1213
"dev": "tsx src/index.ts",
1314
"check": "tsc --noEmit -p tsconfig.json",
1415
"test": "pnpm run build && node --test dist/**/*.test.js"

0 commit comments

Comments
 (0)