Installation¶
Cognidesk is modular. A minimal direct-runtime project needs Core, a storage adapter, a model adapter, a concrete model provider, and your schema library imports.
Install the runtime packages¶
Add optional packages¶
Install only the adapters and surfaces your application uses:
| Package | Purpose |
|---|---|
@cognidesk/core |
Runtime, agents, journeys, tools, knowledge |
@cognidesk/http |
HTTP/SSE transport adapter |
@cognidesk/model |
Vercel AI SDK model adapter and model-role helpers |
@cognidesk/react |
React hooks and chat widget |
@cognidesk/ui |
Prebuilt UI components |
@cognidesk/storage |
SQLite/libSQL and Postgres runtime storage adapters |
@cognidesk/otel |
OpenTelemetry instrumentation |
@cognidesk/integration-{category}-{provider} |
External Provider Integrations installed one provider at a time, such as @cognidesk/integration-email-gmail, @cognidesk/integration-workplace-slack, @cognidesk/integration-email-outlook, @cognidesk/integration-workplace-teams, and @cognidesk/integration-voice-openai |
@cognidesk/integration-catalog |
Provider discovery metadata used by docs, Studio, and application-owned lazy loaders once split provider packages from #23-#25 and #29-#43 publish from integrations/{category}/{provider} |
@cognidesk/voice-websocket |
Browser-facing Cognidesk Voice WebSocket transport |
@cognidesk/journey-index-json |
JSON-based journey index |
@cognidesk/connections |
Reviewed OpenAPI/MCP connection helpers for selected operation aliases |
@cognidesk/evals |
Eval-suite helpers built on the test harness |
@cognidesk/test-harness |
Runtime scenario harness and provider conformance checks |
@cognidesk/studio-adapter |
Optional Studio target introspection adapter |
Provider package examples¶
Install only the provider packages your application enables. The split package work is staged behind #28, first-wave package issues #23-#25, and provider-family trackers #29-#43; until those packages publish, local examples may still point at legacy workspace modules. Legacy @cognidesk/integrations/* imports should migrate by codemod, not through a compatibility bridge; see Provider Package Migration.
Full installation example¶
TypeScript configuration¶
Cognidesk requires strict mode and ES2022+ target:
tsconfig.json
{
"compilerOptions": {
"strict": true,
"target": "ES2022",
"module": "ESNext",
"moduleResolution": "bundler"
}
}
Next steps¶
Once installed, follow the Quick Start to build your first agent.