cuga-install-and-launch

# Installing and launching cuga ## Install For a new app project, initialize with `uv` and add `cuga` as a dependency so it is recorded in `pyproject.toml`: ```bash uv init my-cuga-app cd my-cuga-app uv add cuga ``` For an existing project that already has a `pyproject.toml`, run `uv add cuga` from the project root. If the user only wants a quick install inside an already-active virtualenv, `uv pip install cuga` is acceptable. (`cuga` requires Python >= 3.10, < 3.14.) For working inside a checkout of the [cuga-agent](https://github.com/cuga-project/cuga-agent) repo itself instead of the published package: ```bash git clone https://github.com/cuga-project/cuga-agent.git cd cuga-agent uv venv --python=3.12 && source .venv/bin/activate uv sync ``` Set LLM API keys before starting anything. Use a project-local `.env`; see `docs/cuga-env-api-keys.md` for provider-specific `AGENT_SETTING_CONFIG`, `MODEL_NAME`, and API-key examples. ## Launch ```bash uv run cuga start <service> ``` Valid `<service>` values: `demo`, `demo_skills`, `demo_crm`, `demo_docs`, `demo_health`, `demo_knowledge`, `demo_supervisor`, `travel_agent`, `manager`, `registry`, `appworld`. - `demo` / `demo_crm` / `demo_supervisor` / `demo_knowledge` / `demo_docs` — launch the chat web UI at `https://localhost:7860` plus a tool registry service on port 8001, each preset wiring up different sample tools (CRM+email, multi-agent supervisor, RAG knowledge, docs) so you can try the matching capability immediately. - `demo_skills` — same UI, with cuga's own runtime skill-loading enabled (see `cuga-build-cuga-skill`). - `manager` — a draft/publish UI: edit agent config (tools, MCP servers, LLM, policies) as a draft, try it, then publish a versioned config for production chat. - `registry` — just the tool registry service (OpenAPI/MCP config), no chat UI. - `appworld` / `travel_agent` — specific benchmark/example scenarios. Other useful commands: - `cuga stop <service>` — stop a running service. - `cuga status` — show what's currently running. - `cuga doctor` — environment/dependency sanity check. - `cuga viz` — trajectory viewer dashboard (see `cuga-debug-trajectory`). There is no `cuga policy` or `cuga knowledge` CLI subcommand — policies and knowledge are managed through the Python SDK (`agent.policies.*`, `agent.knowledge.*`, see `cuga-author-policy` / `cuga-knowledge-rag`) or through the `manager` web UI. ## Next step Once the UI is up, point the user at `cuga-build-agent` for writing their own Python code against the SDK, or have them just chat with the demo agent directly in the browser.