chelydra
/
metal-kompanion
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
metal-kompanion/docs/configuration.md

1.0 KiB
Raw Blame History

Kompanion Configuration

Kompanion adheres to KDE’s KConfig conventions so deployments are kioskable and compatible with other desktop tooling.

Configuration File

  • Location: ${XDG_CONFIG_HOME:-~/.config}/kompanionrc
  • Group: [Database]
  • Key: PgDsn=postgresql://user:pass@host/dbname

The CLI (kompanion) and MCP runner (kom_mcp) fall back to this entry when the PG_DSN environment variable is not set. If neither are present the in-memory DAL stub is used.

Future HTTP Streaming

While current tooling focuses on stdio dispatch (for editor and agent integration), the roadmap includes an HTTP/2 or WebSocket streaming surface so MCP clients can maintain persistent conversations without leaving CLI compatibility behind. The same configuration keys will apply for both transports.

Test Database

Bootstrap a local Postgres instance using the provided scripts:

ROLE=kompanion PASS=komup db/scripts/create-test-db.sh kompanion_test

This loads the schemas from db/init/ and prepares the DSN you can reference in kompanionrc.