@otisworks/batch-kit 0.0.1 → 0.0.2

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 +20 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,10 +5,10 @@ An ergonomic CLI + library for the [Anthropic Message Batches API](https://platf
5
5
  Process large volumes of documents with Claude at **50% off** the standard API cost — without hand-writing JSONL, tracking batch IDs, or reimplementing polling loops.
6
6
 
7
7
  ```bash
8
- batch add --dir ./reviews --prompt "Summarize this review:\n\n{content}"
9
- batch send
8
+ npx batch add --dir ./reviews --prompt "Summarize this review:\n\n{content}"
9
+ npx batch send
10
10
  # ...later...
11
- batch fetch --latest --output summaries.json
11
+ npx batch fetch --latest --output summaries.json
12
12
  ```
13
13
 
14
14
  ---
@@ -24,16 +24,32 @@ The Batch API is great for cost-effective bulk processing, but the raw developer
24
24
 
25
25
  ## Install
26
26
 
27
+ **As a local project dependency:**
28
+
27
29
  ```bash
28
30
  npm install @otisworks/batch-kit
29
31
  ```
30
32
 
31
- For the CLI globally:
33
+ Run the CLI with `npx`:
34
+
35
+ ```bash
36
+ npx batch <command>
37
+ ```
38
+
39
+ **Or install globally** to use the bare `batch` command:
32
40
 
33
41
  ```bash
34
42
  npm install -g @otisworks/batch-kit
43
+ batch <command>
35
44
  ```
36
45
 
46
+ > **Note:** With a local install, run commands as `npx batch ...`. The bare
47
+ > `batch` command only works after a global install (`npm i -g`). Without one,
48
+ > your shell may resolve `batch` to an unrelated system utility.
49
+ >
50
+ > The examples below use the bare `batch` command; prefix them with `npx` if
51
+ > you installed locally.
52
+
37
53
  ## Setup
38
54
 
39
55
  Set your API key via environment variable or a `.env` file in your working directory:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@otisworks/batch-kit",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "Ergonomic CLI + library for the Anthropic Message Batches API",
5
5
  "type": "module",
6
6
  "engines": {