BountyHub Docs
Projects Overview
Projects, workflows, scans, runs, and artifacts — the core BountyHub object model and how they fit together.
#The Object Model
text
- Project (
/u/<you>/projects/<project>) — owns everything: workflows, datasets, vars/secrets/MCP config, and agent setup. Create one per target or program at/projects/new. - Workflow (
.../workflows/<workflow>) — a saved BHW definition. Editing creates a new revision; dispatches always run against a pinned revision, so a scan is reproducible. - Scan — a dispatch of a workflow revision: manual
(
trigger.dispatch), scheduled (trigger.cron), or event-driven (trigger.on(...)). Dispatch manually from the workflow page or the CLI:
bash
- Run (
.../scans/<scan>/runs/<id>, list at.../workflows/<workflow>/runs) — one execution of a scan on a runner. The run tree shows every activity and step with status, logs, and produced files. - Artifacts — files handed between activities via
step.upload_artifact/step.download_artifact(see Steps). They belong to the run; control retention withexpires_in = duration.days(7).
#Project Tabs
| Tab | Purpose | Docs |
|---|---|---|
| Workflows | Definitions, revisions, scans, runs | Workflows |
| Datasets | Asset inventory accumulated across runs | Datasets guide |
| Vars / Secrets / MCP | External configuration referenced via config.* | Configuration |
| Agent | Chat, providers, skills for this project | BH Agent |
#Next Steps
- Runs & Artifacts: Read results and pull files with the CLI.
- Workflows Overview: Write the automation itself.
- Runners: Provide the compute runs execute on.