@durable-streams/cli 0.1.2 → 0.1.3

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.
Files changed (2) hide show
  1. package/README.md +19 -12
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -4,31 +4,38 @@ A command-line tool for interacting with durable streams.
4
4
 
5
5
  ## Installation
6
6
 
7
- ### Local Development
7
+ ### From npm
8
8
 
9
9
  ```bash
10
- # Install dependencies
11
- pnpm install
10
+ # Global installation
11
+ npm install -g @durable-streams/cli
12
12
 
13
- # Build the CLI (for production bin)
14
- pnpm build
13
+ # Or run directly with npx
14
+ npx @durable-streams/cli create my-stream
15
+ npx @durable-streams/cli read my-stream
15
16
  ```
16
17
 
17
- ### Global Installation for Development
18
-
19
- For development, you can link the CLI globally with live TypeScript execution (no rebuild needed):
18
+ ### From source (for development)
20
19
 
21
20
  ```bash
22
- # From the CLI package directory
21
+ # Clone the repository
22
+ git clone https://github.com/durable-streams/durable-streams.git
23
+ cd durable-streams
24
+
25
+ # Install dependencies
26
+ pnpm install
27
+
28
+ # Build the CLI
29
+ pnpm build
30
+
31
+ # Link globally for development (uses tsx, no rebuild needed)
32
+ cd packages/cli
23
33
  pnpm link:dev
24
34
 
25
35
  # Now you can use durable-stream-dev anywhere
26
- # Changes to src/index.ts are immediately available
27
36
  durable-stream-dev create my-stream
28
37
  ```
29
38
 
30
- This uses `tsx` to run the TypeScript source directly, so you see changes immediately without rebuilding.
31
-
32
39
  ## Quick Start
33
40
 
34
41
  The easiest way to get started is to run the local development server and use the CLI:
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "@durable-streams/cli",
3
3
  "description": "CLI tool for working with Durable Streams",
4
- "version": "0.1.2",
4
+ "version": "0.1.3",
5
5
  "author": "Durable Stream contributors",
6
6
  "bin": {
7
+ "cli": "./dist/index.js",
7
8
  "durable-stream": "./dist/index.js",
8
9
  "durable-stream-dev": "./bin/durable-stream-dev.mjs"
9
10
  },
@@ -18,7 +19,7 @@
18
19
  "tsdown": "^0.9.0",
19
20
  "tsx": "^4.19.2",
20
21
  "typescript": "^5.5.2",
21
- "@durable-streams/server": "0.1.2"
22
+ "@durable-streams/server": "0.1.3"
22
23
  },
23
24
  "engines": {
24
25
  "node": ">=18.0.0"