@cognidesk/otel 0.0.3-dev.7 → 0.0.3-dev.9

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 +33 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  [![SDK License](https://img.shields.io/badge/SDK-Apache--2.0-purple.svg)](LICENSES/Apache-2.0.txt)
8
8
  [![Studio License](https://img.shields.io/badge/Studio-source--available-slate.svg)](LICENSES/Cognidesk-Studio-Source-Available-License.txt)
9
9
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
10
- [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
10
+ [![Node.js](https://img.shields.io/badge/Node.js-24+-green.svg)](https://nodejs.org/)
11
11
 
12
12
  [Documentation](https://cognidesk.cognilabz.com) · [Quick Start](https://cognidesk.cognilabz.com/getting-started/quick-start/) · [Examples](https://cognidesk.cognilabz.com/examples/) · [API Reference](https://cognidesk.cognilabz.com/api-reference/)
13
13
 
@@ -41,7 +41,7 @@ const agent = createAgent("support", {
41
41
  const runtime = createRuntime({
42
42
  storage: createSqliteStorage({ filename: "data.sqlite" }),
43
43
  agent,
44
- models,
44
+ models, // See the Quick Start for createModelSet configuration.
45
45
  });
46
46
  ```
47
47
 
@@ -66,32 +66,58 @@ const runtime = createRuntime({
66
66
  | `@cognidesk/ui` | Prebuilt UI components |
67
67
  | `@cognidesk/storage` | Storage adapters |
68
68
  | `@cognidesk/otel` | OpenTelemetry instrumentation |
69
- | `@cognidesk/voice-openai` | OpenAI Realtime voice adapter |
69
+ | `@cognidesk/integrations` | External Provider Integrations with category/provider subpaths, such as `@cognidesk/integrations/email/gmail`, `@cognidesk/integrations/voice/openai`, and `@cognidesk/integrations/voice/elevenlabs` |
70
70
  | `@cognidesk/voice-websocket` | Voice WebSocket adapter |
71
71
  | `@cognidesk/journey-index-json` | JSON-based journey index |
72
72
 
73
73
  ## Quick start
74
74
 
75
75
  ```bash
76
- pnpm add @cognidesk/core @cognidesk/http @cognidesk/storage @libsql/client
76
+ pnpm add @cognidesk/core @cognidesk/http @cognidesk/model @cognidesk/storage @libsql/client @ai-sdk/openai zod
77
77
  ```
78
78
 
79
79
  Read the full [Quick Start guide →](https://cognidesk.cognilabz.com/getting-started/quick-start/)
80
80
 
81
81
  ## Demo
82
82
 
83
- Run the flight support demo:
83
+ Repository development uses Node.js 24 and the pinned pnpm version from
84
+ `package.json`:
85
+
86
+ ```bash
87
+ corepack enable
88
+ pnpm install
89
+ ```
90
+
91
+ Run the flight support demo locally:
92
+
93
+ ```bash
94
+ cp apps/flight-demo/config.openrouter.example.json apps/flight-demo/config.json
95
+ export OPENROUTER_KEY=sk-or-...
96
+ pnpm --filter @cognidesk/flight-demo ingest:knowledge
97
+ pnpm demo
98
+ ```
99
+
100
+ Open `http://localhost:5173` for the demo frontend,
101
+ `http://localhost:8787/api` for the API, and `http://localhost:3000` for
102
+ Cognidesk Studio. The default local Studio login is
103
+ `admin@local.cognidesk.dev` / `cognidesk-studio-admin`.
104
+
105
+ Docker uses the same config and model credentials:
84
106
 
85
107
  ```bash
86
108
  docker compose up --build
87
109
  ```
88
110
 
89
- Open `http://localhost:5173` for the frontend, `http://localhost:8787/api` for the API.
111
+ Use the OpenTelemetry compose file when you want Grafana, Tempo, Prometheus,
112
+ Loki, and Promtail:
113
+
114
+ ```bash
115
+ docker compose -f docker-compose.otel.yml up --build
116
+ ```
90
117
 
91
118
  ## Development
92
119
 
93
120
  ```bash
94
- pnpm install
95
121
  pnpm check
96
122
  ```
97
123
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cognidesk/otel",
3
- "version": "0.0.3-dev.7",
3
+ "version": "0.0.3-dev.9",
4
4
  "license": "Apache-2.0",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",