Skip to content

CLI reference

This page is the current CLI reference for command discovery and mirrors the front-door product story: release confidence first, expansion second.

Primary outcome: know if a change is ready to ship.

Canonical first path: python -m sdetkit gate fast β†’ python -m sdetkit gate release β†’ python -m sdetkit doctor.

It intentionally prioritizes:

  1. the canonical public/stable first-time path,
  2. stability-aware expansion into advanced surfaces,
  3. clear demotion of transition-era or legacy-oriented material.

Canonical first-time path (public / stable)

Use this exact sequence first:

  1. python -m sdetkit gate fast
  2. python -m sdetkit gate release
  3. python -m sdetkit doctor

This is the primary product path for first-time adoption and release-confidence proof. If a new visitor remembers only one thing, it should be this exact path.

Stability-aware command discovery

After the canonical path is working, expand deliberately:

Advanced but supported

  • Umbrella kits: sdetkit kits list, sdetkit kits describe <kit>
  • Release Confidence Kit: sdetkit release ...
  • Test Intelligence Kit: sdetkit intelligence ...
  • Integration Assurance Kit: sdetkit integration ...
  • Failure Forensics Kit: sdetkit forensics ...

Public/stable compatibility aliases (secondary for discovery)

These remain fully supported for existing automation and muscle memory:

  • gate, doctor, security, repo, evidence, report, policy

Supporting utilities (secondary)

Available utility lanes include:

  • kv, apiget, cassette-get, patch, maintenance, ops, notify, agent

Transition-era and legacy-oriented material

Transition-era and archived lanes remain available for compatibility, but they are not first-time entrypoints and should not dominate discovery:

Contract expectations

Public kit commands are contract-oriented:

  • machine-readable JSON with schema_version
  • deterministic ordering and reproducible artifacts
  • stable exit-code lanes (0 success, 1 policy/contract failure, 2 invalid input/usage)