Get started

Primary path: hybrid sidecar. Your LLM keeps generation; SoulOS owns persona and memory.

1. Start the sidecar stack

git clone https://github.com/mziqudhd92/soul-os.git
cd soul-os
docker compose -f docker-compose.sidecar.yml --profile bridge-mock up -d

Kernel listens on http://localhost:8001 in the sidecar compose file (or :8000 for full stack).

2. Smoke test

npm run smoke:hybrid

Runs ensure → doctor → prepare and prints the system prompt.

3. Wire your app

4. Optional — start from a SoulPack

Import a first-party MIT persona, then run hybrid turns.

curl -s -X POST http://localhost:8000/v1/avatars/import-soulpack \
  -H 'content-type: application/json' \
  -d '{"pack_id":"support-agent","persist":true}'

Details: SoulPacks · guide.

Secondary paths