@bizone-ai/cli 0.1.0 → 0.1.1

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 +23 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -14,6 +14,27 @@ Works on **macOS** and **Windows**.
14
14
 
15
15
  Requires **Node.js >= 18** and a running **Docker** engine.
16
16
 
17
+ ### Global install (recommended)
18
+
19
+ Install the published package globally so the `bizone` command is on your PATH:
20
+
21
+ ```bash
22
+ npm install -g @bizone-ai/cli
23
+ bizone --version
24
+ ```
25
+
26
+ ### Run without installing (npx)
27
+
28
+ Run the latest published version directly — no install step:
29
+
30
+ ```bash
31
+ npx @bizone-ai/cli <category> <command> [args]
32
+ # e.g.
33
+ npx @bizone-ai/cli start
34
+ ```
35
+
36
+ ### From source (local clone)
37
+
17
38
  ```bash
18
39
  cd cli
19
40
  npm install # no runtime dependencies, but sets up the bin link
@@ -26,7 +47,8 @@ Or run directly without linking:
26
47
  node cli/bin/bizone.js <category> <command> [args]
27
48
  ```
28
49
 
29
- All examples below assume the `bizone` command is on your PATH.
50
+ All examples below assume the `bizone` command is on your PATH (via global
51
+ install, `npm link`, or `npx @bizone-ai/cli`).
30
52
 
31
53
  ---
32
54
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bizone-ai/cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Assistant CLI for running the Bizone orchestrator platform locally with Docker",
5
5
  "type": "module",
6
6
  "bin": {