@effectstream/orchestrator 0.102.0 → 0.103.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 +46 -11
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -81,17 +81,52 @@ defaults.
81
81
  ## CLI reference
82
82
 
83
83
  ```
84
- orchestrator start [config] Start processes (daemonised, exposes HTTP API)
85
- orchestrator status Show process status
86
- orchestrator restart <name> Restart a named process
87
- orchestrator stop [name] Stop a named process, or all
88
- orchestrator list [config] List processes without starting
89
- orchestrator silence <name...> Suppress terminal output for named processes
90
- orchestrator unsilence <name...> Resume terminal output
91
- orchestrator logs [name...] Follow background daemon log files
92
-
93
- Global flags:
94
- --port <n> Orchestrator API port (default: 4747)
84
+ orchestrator start [config|name...] Start all processes, or specific ones by name
85
+ orchestrator status Show process status
86
+ orchestrator restart <name> Restart a named process
87
+ orchestrator stop [name] Stop a named process, or all
88
+ orchestrator list [config] List processes without starting
89
+ orchestrator silence [name...] Suppress terminal output (no args = show list)
90
+ orchestrator unsilence <name...> Resume terminal output
91
+ orchestrator logs [name...] Follow background daemon log files (like tail -f)
92
+ ```
93
+
94
+ **Global options**
95
+
96
+ | Flag | Description |
97
+ | --- | --- |
98
+ | `-c, --config <path>` | Config file. Auto-detected from the daemon, `package.json`'s `effectstream.default`, or `orchestrator.config.ts` when omitted. |
99
+ | `-h, --help` | Print help. |
100
+
101
+ **Options for `start`**
102
+
103
+ | Flag | Description |
104
+ | --- | --- |
105
+ | `-b, --background` | Run as a detached background daemon; logs go to files. Required before `status`, `logs` and `restart` can talk to a daemon. |
106
+ | `-p, --port <n>` | Orchestrator API port (default: `4747`). |
107
+ | `-o, --only <p1,p2,…>` | Run only these processes, plus their dependencies. |
108
+ | `-e, --except <p1,p2,…>` | Skip these processes. |
109
+ | `-s, --serial` | Launch processes one at a time instead of in parallel waves. |
110
+ | `--no-deps` | Launch only the named processes, skipping dependency resolution. |
111
+ | `--log-dir <path>` | Log directory when using `-b` (default: `.orchestrator-logs`). |
112
+ | `--no-api` | Disable the HTTP API server. |
113
+ | `--silence <p1,p2,…>` | Suppress terminal output for these processes. |
114
+
115
+ **Options for `status`**
116
+
117
+ | Flag | Description |
118
+ | --- | --- |
119
+ | `-f, --follow` | Continuously refresh the status table, at a 1s interval. |
120
+
121
+ **Examples**
122
+
123
+ ```bash
124
+ orchestrator start hardhat deploy-evm-contracts
125
+ orchestrator start --only=midnight-node,midnight-indexer
126
+ orchestrator start --except=avail-client
127
+ orchestrator start --silence=midnight-node,bitcoin-core
128
+ orchestrator restart midnight-node
129
+ orchestrator stop batcher
95
130
  ```
96
131
 
97
132
  ## Inside EffectStream
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@effectstream/orchestrator",
3
- "version": "0.102.0",
3
+ "version": "0.103.1",
4
4
  "license": "(MIT OR Apache-2.0)",
5
5
  "homepage": "https://effectstream.github.io/docs/",
6
6
  "repository": {
@@ -33,7 +33,7 @@
33
33
  "start": "bun src/cli.ts start"
34
34
  },
35
35
  "dependencies": {
36
- "@effectstream/db": "0.102.0"
36
+ "@effectstream/db": "0.103.1"
37
37
  },
38
38
  "description": "Multi-chain local development environment for EffectStream"
39
39
  }