@shelby-protocol/cli 0.0.7 → 0.0.9
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 +59 -11
- package/bin/entry.js +7852 -1731
- package/package.json +21 -18
package/README.md
CHANGED
|
@@ -4,21 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
# Install dependencies
|
|
9
|
-
pnpm install # or npm install / yarn install
|
|
7
|
+
### For End Users
|
|
10
8
|
|
|
11
|
-
|
|
12
|
-
pnpm run build
|
|
9
|
+
Install globally via npm:
|
|
13
10
|
|
|
14
|
-
|
|
15
|
-
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g @shelby-protocol/cli
|
|
16
13
|
```
|
|
17
14
|
|
|
18
|
-
|
|
15
|
+
Verify installation:
|
|
19
16
|
|
|
20
17
|
```bash
|
|
21
|
-
shelby
|
|
18
|
+
shelby --version
|
|
22
19
|
```
|
|
23
20
|
|
|
24
21
|
## Scripts
|
|
@@ -31,7 +28,58 @@ shelby <command> [options]
|
|
|
31
28
|
| `start` | `node dist/entry.js` | Run the compiled CLI (production build) |
|
|
32
29
|
| `test` | `vitest run` | Run the test suite once (CI / pre-commit)|
|
|
33
30
|
|
|
34
|
-
##
|
|
31
|
+
## NPM Release
|
|
35
32
|
|
|
36
33
|
1. Bump version
|
|
37
|
-
2. Run `npm publish`
|
|
34
|
+
2. Run `npm publish`
|
|
35
|
+
|
|
36
|
+
## Contributing
|
|
37
|
+
|
|
38
|
+
### Development Setup
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Install dependencies
|
|
42
|
+
pnpm install
|
|
43
|
+
|
|
44
|
+
# Run from typescript dir / turborepo root
|
|
45
|
+
# This ensures dependencies are also built (i.e., sdk)
|
|
46
|
+
pnpm build --filter @shelby-protocol/cli
|
|
47
|
+
|
|
48
|
+
# Local testing
|
|
49
|
+
pnpm start
|
|
50
|
+
|
|
51
|
+
# Or link globally for testing
|
|
52
|
+
pnpm link --global
|
|
53
|
+
shelby <command> [options]
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Development Workflow
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Run linter
|
|
60
|
+
pnpm lint
|
|
61
|
+
|
|
62
|
+
# Auto-format code
|
|
63
|
+
pnpm fmt
|
|
64
|
+
|
|
65
|
+
# Run tests
|
|
66
|
+
pnpm test
|
|
67
|
+
|
|
68
|
+
# Build
|
|
69
|
+
pnpm build
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Testing Commands
|
|
73
|
+
|
|
74
|
+
During development, you can test CLI commands using `pnpm dev` instead of `shelby`:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# Instead of: shelby init
|
|
78
|
+
pnpm dev init
|
|
79
|
+
|
|
80
|
+
# Instead of: shelby upload <input> <output> -e <expiration>
|
|
81
|
+
pnpm dev upload ./myfile.txt myfile.txt -e 1735689600
|
|
82
|
+
|
|
83
|
+
# Instead of: shelby account list
|
|
84
|
+
pnpm dev account list
|
|
85
|
+
```
|