Files
ai-exchange/RUNBOOK.md
T

1.5 KiB

ai-exchange Runbook

Project Summary

  • Package name: ai-ict
  • Python version: >=3.11
  • Main local API port: 8000
  • Default branch observed during setup: main

Setup

cd /home/yuqei/project/ai-exchange
test -d .venv || uv sync
test -f .env || cp .env.example .env

Local Run

cd /home/yuqei/project/ai-exchange
.venv/bin/python scripts/run_api_server.py

Alternative entrypoints already documented by the project:

python3 scripts/run_dev.py
python3 scripts/run_pipeline.py

Test And Validation

cd /home/yuqei/project/ai-exchange
.venv/bin/python -m unittest discover -s tests/unit -p "test_*.py"
.venv/bin/python scripts/run_offline_checks.py
.venv/bin/python scripts/check_local_demo_readiness.py
python3 scripts/run_migration_static_checks.py
python3 scripts/run_script_static_checks.py

Docker

Repo-local compose:

cd /home/yuqei/project/ai-exchange
docker compose up -d --build
docker compose ps

Documented single-set local deployment policy from the repo README:

cd /root/deploy/ai-ict
docker compose -p ai-ict -f /root/deploy/ai-ict/docker-compose.yml down --remove-orphans
docker compose -p ai-ict -f /root/deploy/ai-ict/docker-compose.yml up -d --build
docker compose -p ai-ict -f /root/deploy/ai-ict/docker-compose.yml ps

Notes

  • Existing services in docker-compose.yml: ai-ict
  • Existing mapped port in docker-compose.yml: 8000:8000
  • Use SESSION.md for the exact next step instead of relying on conversation memory.