@ciandt-flow/flow-ai-obs 0.16.1-beta.136 → 1.0.0-beta.146
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 +17 -14
- package/dist/cli.js +161 -247
- package/dist/index.js +13 -21
- package/dist/setup.js +14 -14
- package/package.json +1 -4
package/README.md
CHANGED
|
@@ -2,37 +2,39 @@
|
|
|
2
2
|
|
|
3
3
|
> Automatic observability for Claude Code sessions — powered by [Flow by CI&T](https://flow.ciandt.com).
|
|
4
4
|
|
|
5
|
-
`flow-ai-obs`
|
|
5
|
+
`flow-ai-obs` configures Claude Code's native OpenTelemetry integration to report metrics and logs to Flow, authenticated with a single `FLOW_API_KEY` — no proxy, no separate login step.
|
|
6
6
|
|
|
7
|
-
- **
|
|
8
|
-
- **
|
|
9
|
-
- **
|
|
10
|
-
- **Offline buffer** — traces are persisted locally and replayed automatically when the gateway is back online
|
|
7
|
+
- **Native OTEL metrics and logs** — Claude Code reports directly, no hooks or subprocesses involved
|
|
8
|
+
- **Zero-friction auth** — one environment variable (`FLOW_API_KEY`), no interactive login
|
|
9
|
+
- **Direct mode (opt-in)** — send traces straight to your own Langfuse instance via `FLOW_TELEMETRY=true` (see [`docs/work-modes/`](docs/work-modes/))
|
|
11
10
|
|
|
12
11
|
---
|
|
13
12
|
|
|
14
13
|
## Requirements
|
|
15
14
|
|
|
16
15
|
- Node.js >= 18.0.0
|
|
17
|
-
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code)
|
|
18
|
-
- A
|
|
16
|
+
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code)
|
|
17
|
+
- A `FLOW_API_KEY` for your [Flow by CI&T](https://flow.ciandt.com) tenant, set in your environment
|
|
19
18
|
|
|
20
19
|
---
|
|
21
20
|
|
|
22
21
|
## Quick Start
|
|
23
22
|
|
|
24
23
|
```bash
|
|
25
|
-
# 1.
|
|
24
|
+
# 1. Set your Flow API key (see your Flow tenant's setup guide for where to get it)
|
|
25
|
+
export FLOW_API_KEY="<YOUR_FLOW_API_KEY>"
|
|
26
|
+
|
|
27
|
+
# 2. Install globally
|
|
26
28
|
npm install -g @ciandt-flow/flow-ai-obs
|
|
27
29
|
|
|
28
|
-
#
|
|
30
|
+
# 3. Run init — configures native OTEL telemetry for Claude Code
|
|
29
31
|
flow-ai-obs init
|
|
30
32
|
|
|
31
|
-
#
|
|
33
|
+
# 4. Verify
|
|
32
34
|
flow-ai-obs status
|
|
33
35
|
```
|
|
34
36
|
|
|
35
|
-
That's it.
|
|
37
|
+
That's it. Claude Code now reports metrics and logs automatically via native OpenTelemetry.
|
|
36
38
|
|
|
37
39
|
---
|
|
38
40
|
|
|
@@ -40,11 +42,12 @@ That's it. Every Claude Code session with Skills or Agents now generates traces
|
|
|
40
42
|
|
|
41
43
|
| Command | Description |
|
|
42
44
|
|---------|-------------|
|
|
43
|
-
| `flow-ai-obs init` | Configure environment:
|
|
44
|
-
| `flow-ai-obs
|
|
45
|
-
| `flow-ai-obs status` | Show current auth status and hook configuration |
|
|
45
|
+
| `flow-ai-obs init` | Configure environment: native OTEL telemetry for Claude Code |
|
|
46
|
+
| `flow-ai-obs status` | Show current authentication and observability configuration |
|
|
46
47
|
| `flow-ai-obs update` | Update to the latest version |
|
|
47
48
|
|
|
49
|
+
> `FLOW_API_KEY` is the only supported authentication method — there is no `login` command.
|
|
50
|
+
|
|
48
51
|
### init flags
|
|
49
52
|
|
|
50
53
|
```bash
|