@shelby-protocol/cli 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/bin/entry.js +900 -0
- package/package.json +68 -0
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @shelby-protocol/cli
|
|
2
|
+
|
|
3
|
+
> **Shelby** – A CLI tool for preparing, uploading, and reading data on Shelby.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Install dependencies
|
|
9
|
+
pnpm install # or npm install / yarn install
|
|
10
|
+
|
|
11
|
+
# Build for production
|
|
12
|
+
pnpm run build
|
|
13
|
+
|
|
14
|
+
# Local testing
|
|
15
|
+
pnpm start
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
You can also link it globally and do
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
shelby <command> [options]
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Scripts
|
|
25
|
+
|
|
26
|
+
| Script | Command | Description |
|
|
27
|
+
| ------- | --------------------------------- | ---------------------------------------- |
|
|
28
|
+
| `lint` | `biome check .` | Run linter to catch style & error issues |
|
|
29
|
+
| `fmt` | `biome check . --write` | Auto-format and fix issues |
|
|
30
|
+
| `build` | `rimraf dist && rimraf bin; tsup` | Clean & bundle the CLI into `dist/` |
|
|
31
|
+
| `start` | `node dist/entry.js` | Run the compiled CLI (production build) |
|
|
32
|
+
| `test` | `vitest run` | Run the test suite once (CI / pre-commit)|
|
|
33
|
+
|
|
34
|
+
## Binary Release
|
|
35
|
+
|
|
36
|
+
### Install `Bun`
|
|
37
|
+
|
|
38
|
+
On homebrew, you can do:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
brew tap oven-sh/bun
|
|
42
|
+
|
|
43
|
+
brew install bun
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
If you don't have homebrew, see https://bun.sh/get
|
|
47
|
+
|
|
48
|
+
### Run `scripts/bun-release.sh`
|
|
49
|
+
|
|
50
|
+
From `apps/cli` run `bash scripts/bun-release.sh`
|