Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.roboticks.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Generating an Evidence Pack

There are three entry points. They all enqueue the same builder pipeline and produce the same artefact in all three formats.

​
From the dashboard

The path most users take.
1

Open the release

Releases → choose a release → Overview. The release must be in state verified or shipped (see Release scoping). A draft or verifying release cannot produce a pack.
2

Click Generate Evidence Pack

A modal asks for the formats to render (PDF, ZIP, ReqIF — ReqIF is gated to Team and Enterprise) and any customization overrides (Enterprise only).
3

Watch the progress

The builder reports phase-by-phase progress via a websocket. Typical phases: snapshot requirements → collect JUnit XMLs → resolve MCAP references → assemble coverage → fetch SBOM → render PDF → assemble ZIP → sign manifest → upload to S3.
4

Download or share

When the pack is ready, the release page shows a download link for each format and a read-only share link for handing to an external party. Share links are signed, time-bounded, and revocable.
The release page now shows a green Pack generated badge with the SHA-256 of the manifest and a link to verify the hash chain.

​
From the API

For programmatic generation — release-gate scripts, custom CI jobs, integration with a release-train tool. 
curl -X POST https://api.roboticks.io/api/v1/organizations/{org_slug}/projects/{project_slug}/releases/{release_id}/evidence-pack \
  -H "Authorization: Bearer $RBTK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "formats": ["pdf", "zip", "reqif"],
    "include_screenshots": true
  }'
The response returns a job_id immediately. Poll GET /evidence-pack-jobs/{job_id} or subscribe to the websocket for progress. On success the body returns three signed download URLs (one per format) valid for 7 days.

​
From the CLI

The fastest path inside a CI pipeline or a developer shell. 
# By release
rbtk test evidence-pack --release v1.4.0 --format pdf

# By release, multiple formats
rbtk test evidence-pack --release v1.4.0 --format pdf,zip,reqif

# Ad-hoc, by branch + commit set
rbtk test evidence-pack \
  --branch main \
  --commit-set abc123,def456 \
  --format zip
The CLI blocks on the job by default, streams progress to stdout, and writes the resulting file(s) into ./evidence-packs/. Add --no-wait to get just the job_id back. See CLI commands for the full flag list.

​
The builder pipeline

The builder is a single AWS Lambda with a 15-minute budget. Packs that exceed the budget — typically very large repos with multi-gigabyte MCAP indexes — automatically fall back to an ECS Fargate task with a 6-hour budget. The fallback is transparent; the API and CLI behaviour does not change.

​
Typical generation times

Project sizeFormatTime
Small (50 reqs, 200 tests, 1 GB MCAPs)PDF only15–30 s
SmallAll three30–60 s
Medium (500 reqs, 2 k tests, 20 GB MCAPs)All three2–5 min
Large (5 k reqs, 20 k tests, 200 GB MCAPs)All three8–15 min
Very large (Lambda → Fargate fallback)All three20–90 min
MCAP size dominates. The builder never copies MCAPs into the pack — it references them by presigned URL — but it still verifies integrity by computing SHA-256s in parallel.

​
Errors and partial packs

A pack with any unresolved dependency (a missing MCAP, an unreachable connector, a corrupt SARIF) fails the job rather than producing a partial pack. The error is surfaced with the specific artefact at fault, and you can re-run after fixing the upstream. The platform never produces a silent best-effort pack. Auditors rely on completeness. For triage workflows where a partial view is useful, use rbtk test evidence-pack --allow-partial. The resulting pack is marked partial: true in its manifest, refuses to enter the hash chain, and is watermarked NOT FOR AUDIT in the PDF.

​
Next steps

Formats deep dive

What the PDF, ZIP, and ReqIF deliverables look like.

Customise the pack

Cover pages, branding, custom sections. Enterprise.

Hand off to an auditor

Recommended cover letter and disclaimer.

Verify the chain

Prove a historical pack has not been altered.