Use this path after an administrator has deployed CodeGraph and given you the instance URL, an account, and access to at least one project. For a new server, follow the installation guide first.
1. Check that the instance is ready
Open <codegraph-url>/health. A successful response proves that the API endpoint is reachable.
Check project-graph currency through the project status and CPG revision. If the endpoint is
unavailable, send the URL and response time to the administrator.
2. Select or import a project
Open /dashboard/projects and select a project you are authorized to use. If your role allows
project import, add the repository through the project interface and wait for ingestion to
finish. Do not paste repository credentials into a project URL; use the credential mechanism
approved for your environment.
Before relying on an answer, check the project status and its CPG freshness. A stale, pending, or failed graph can still produce a response, but that response must be treated as advisory until the graph has been refreshed.
3. Run a first task
Choose a task that has an observable result, for example:
- find the entry points for a component;
- inspect the impact of changing a named symbol;
- review a bounded commit range;
- explain a dependency path and cite its source locations.
Keep the first scope small. Confirm that the response names the selected project, includes source evidence, and states any freshness or availability limitation. A professional engineering or security decision still requires human review.
4. Explore the bundled demo
To see a guided workflow without importing customer documents, open
/dashboard/onboarding-research and select a demo preset. Demo data explains the interface; use
the imported project and its current CPG for repository-specific results.
If the first run fails
- No project is visible: ask the administrator to check tenant and project access.
- CPG is stale or missing: request or wait for project refresh before repeating the analysis.
- The result is blocked: preserve the reason and session identifier for support.
- The result lacks source evidence: narrow the question and verify the selected project.
Contract sources
src/api/main.py— assembled API application and/healthsurface;frontend/src/App.tsx— registered dashboard routes;src/api/routers/projects.py— project operations;src/services/cpg/— project graph lifecycle and freshness behavior.
Next: Installation · Configuration · Scenario catalog