derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
2.6 KiB
2.6 KiB
PerfXpert user guides
End-user-facing how-tos. If you're contributing code instead of running PerfXpert, jump to ../contributing/README.md.
Index
| You want to… | Read |
|---|---|
| Install + run your first analysis | getting-started.md |
Run the first-time wizard (perfxpert init) |
getting-started.md §3.3 |
| Understand how the agent brain works at runtime | agentic-mode.md |
| Drive PerfXpert from a coding backend (opencode / claude / codex / gemini) | backends.md |
| Embed the agent hierarchy in your own Python code | python-api.md |
Visual demo (15 short GIFs)
Embedded throughout getting-started.md. The rendered GIFs are checked in under assets/gifs/.
| # | scenario | gif |
|---|---|---|
| 01 | Install (editable + bundled opencode build) | 01-install.gif |
| 02 | perfxpert --help + analyze --help |
02-help.gif |
| 03 | perfxpert doctor |
03-doctor.gif |
| 04 | --format text |
04-analyze-text.gif |
| 05 | --format json |
05-analyze-json.gif |
| 06 | --format markdown |
06-analyze-markdown.gif |
| 07 | --format webview |
07-analyze-webview.gif |
| 08 | Tier-0 source-only | 08-tier0-source-only.gif |
| 09 | Tier-0 combined (DB + source) | 09-tier0-combined.gif |
| 10 | Live progress spinner | 10-progress-spinner.gif |
| 11 | Pre-flight auth error (clean rc=2) | 11-pre-flight-auth-error.gif |
| 12 | Python API (perfxpert.api) |
12-python-api.gif |
| 13 | MCP server (56 tools) | 13-mcp-server.gif |
| 14 | perfxpert-code interactive |
14-perfxpert-code.gif |
| 15 | All five --llm providers |
15-all-providers.gif |
See also
- ../README.md — top-level docs index
- ../integration/mcp-server.md — MCP wire surface
- ../architecture/agent-hierarchy.md — what each agent does