Developer Documentation
Developer Documentation
On this page
GPUWorks consists of two static Go binaries built with CGO_ENABLED=0 and a React frontend. The control plane entry point is
cmd/gpuworks, and the node entry point is cmd/gpuworks-agent. The frontend lives in ui/, and its build output is embedded in the server.
From Clone to Demo
git clone <repository-url> gpuworks
cd gpuworks
make demomake demo builds the UI, server, and agents for each platform, then starts a local server and a real agent to verify node connection,
disconnection, and reconnection. It also runs on machines without a GPU. When the script finishes, it cleans up the processes and temporary directories created for the run.
For dependencies, ports, and joint frontend/backend development, see Local Setup.
Repository Map
| Directory | Responsibilities |
|---|---|
cmd/ | Server, agent, and catalog maintenance CLI |
internal/server/ | REST, controllers, scheduling, storage, gateway, and Web UI embedding |
internal/agent/ | Connections, detection, runtime, collection, and transport |
internal/proto/ | Server/agent wire contract, including message formats and fields |
pkg/ | Reusable libraries for estimation, model parsing, benchmarking, and log parsing |
ui/ | React + Vite frontend |
test/ | Fake engines/models and assets for test tiers |
The root CLAUDE.md is authoritative for development conventions, and
CONTEXT.md is authoritative for terminology. For detailed package responsibilities, see the
Code Map.
Next Steps
- Code Map: Package Responsibilities
- Local Development Environment
- Test Tiers and Cloud Strategy
- AMD support design: responsibilities, admission and compatibility
- AMD Integration and Hardware Validation
- Benchmark Information and Reporting Standards
- Observability Limits of Per-Request Engine Queue Time
- Community Registry Browsing
- Browser E2E Testing Standards
- Browser E2E Component Checklists
- Release Builds
- Contribution Guide
Was this page helpful?