AGENTS.md
Cursor Cloud specific instructions
Repository overview
This workspace contains three repos. Only amaru has runnable code; the other two (carlota-jo, counsel) are documentation/specification-only at alpha stage.
Amaru sidecar (Python FastAPI backend) — the primary service
- Location:
sidecar/ - Install:
pip install -e ".[dev]"fromsidecar/ - Run server:
python3 -m uvicorn amaru.app:app --host 0.0.0.0 --port 6810fromsidecar/ - Run tests:
python3 -m pytest tests/ -vfromsidecar/ - Lint:
ruff check src/ tests/fromsidecar/(ruff must be installed separately:pip install ruff)
Top-level wiring tests
- Location:
tests/test_chakana_wiring.py - Run:
PYTHONPATH=src python3 -m pytest tests/test_chakana_wiring.py -vfrom the repo root - The test imports
chakana_wiringfromsrc/chakana_wiring.py; you must setPYTHONPATH=srcor pytest won't find the module.
Web frontend (standalone)
- Location:
web/ - Install:
npm installfromweb/ - Run dev server:
VITE_PORT=5300 BASE_PATH=/ API_TARGET=http://localhost:6810 npx vite --host 0.0.0.0fromweb/ - Build:
npm run buildfromweb/(outputs toweb/dist/) - The frontend uses stub modules in
web/src/_stubs/for all workspace packages that originally came from the parent platform monorepo. These stubs provide fully functional implementations. - The Vite dev server proxies
/api/amaru/*to the FastAPI backend atAPI_TARGET.
Hugging Face Spaces deployment
- Deploy script:
deploy/huggingface/deploy.sh - Requires
HF_TOKENenv var. Usage:HF_TOKEN=hf_xxx bash deploy/huggingface/deploy.sh [space-name] - Builds both frontend and backend into a single Docker container serving on port 7860.
Gotchas
pip installputs scripts in~/.local/binwhich may not be on PATH. Either usepython3 -m <tool>orexport PATH="$HOME/.local/bin:$PATH".- The
huklla-7tripwire (bus publish) will always showwarnwhen running locally — the yawar-bus (Prism Bus) is a separate external service and is not expected to be available. - DCO sign-off (
git commit -s) is enforced by CI on all commits.