VectorCI guide
Validate configuration and prove readiness
Keep local contract checks, GitHub identity, exact branch configuration, and live App-owned execution proof distinct.
Contract and operational validation
Validate without options parses .vectorci.yml, normalizes its job metadata, computes a digest, and reports local readiness blockers without contacting GitHub or claiming that capacity executed the job.
Validate with --require-ready additionally runs the end-to-end doctor proof. It returns READY only when the same local configuration is on the exact GitHub default-branch head and that head has a successful provider-owned VectorCI result. Accepted single-host constraints remain visible under limitations.
npx vectorci validate .
npx vectorci validate . --require-ready
End-to-end doctor
Doctor reads GitHub state and returns READY only when the exact default-branch head has a successful provider-owned VectorCI result. It uses the App-owned Check Run when the credential can read Checks, otherwise it requires the separate provider status created by immutable App bot user id 313620140.
npx vectorci doctor .
Report proof honestly
- Identify the exact local and remote commit.
- Report local configuration validity separately.
- Report the proof source, provider identity, conclusion, and exact head SHA.
- For high-availability routes, call out missing capacity, secondary routes, warm spares, or failover evidence as blockers rather than hiding them behind a green local check.
- For an exact constrained single-host envelope, report the shared physical failure domain as a limitation and call same-host replacement recovery, never failover.