Skip to content

README standout features + TUI-first restructure (demo, doctor)#9

Merged
21tmccauley merged 2 commits into
mainfrom
feat/readme-standouts
Jul 9, 2026
Merged

README standout features + TUI-first restructure (demo, doctor)#9
21tmccauley merged 2 commits into
mainfrom
feat/readme-standouts

Conversation

@21tmccauley

Copy link
Copy Markdown
Collaborator

Makes the README land harder on first read and adds two small showcase features. Builds on the merged CI, versioning, and KSI work.

README

  • Reordered the "how to use it" narrative to TUI → AI agent → CLI (was manual-CLI-first). New flow: Supported services → Install → The TUIDrive it with an AI agentUsing the CLI → How it runs (architecture) → layout/docs. The scattered usage bits (command surface, doctor, manifest building, upload) are consolidated under "Using the CLI".
  • Badge row: CI, license, Python, version.
  • "Drive it with an AI agent" section leaning on --json everywhere, the {ok, errors} manifest contract, and the shipped .claude/skills.

Features

  • Zero-credential demo: a synthetic demo_hello fetcher (new demo category) + examples/demo.yaml, so paramify run examples/demo.yaml exercises the whole collect → envelope pipeline with no cloud account. Doubles as a CI smoke fixture.
  • paramify doctor [manifest] (api.doctor + CLI): preflights Python version, the external CLIs each category needs (aws/jq, kubectl, checkov/git), and — with a manifest — whether its secret env vars are set; exits non-zero on gaps.

Deliberately parked

  • The FedRAMP 20x coverage section (badge + family table) is not published — we're not yet confident enough in the KSI mapping. tools/gen_ksi_coverage.py is kept but parks gracefully when the README markers are absent, ready to resume later. paramify ksi still computes live numbers.
  • Removed the "Why the design is strict" section; the pre-1.0 Status note was preserved (moved into "How it runs").

Tests

  • tests/test_cli.py: EXPECTED_TOP adds ksi + doctor; two new doctor tests.
  • Local: ruff + mypy clean; 209 tests pass; smoke describes all fetchers; demo runs end-to-end.

🤖 Generated with Claude Code

Tate McCauley and others added 2 commits July 9, 2026 15:02
…dges

Four additions to make the repo land harder on first read:

- FedRAMP 20x KSI coverage in the README (badge + family table + named gaps),
  generated from `paramify ksi` by tools/gen_ksi_coverage.py between markers so
  it never drifts (SEC-27 "generate the rot-prone parts" pattern).
- Zero-credential demo: a synthetic `demo_hello` fetcher (new `demo` category)
  + examples/demo.yaml, so `paramify run examples/demo.yaml` exercises the whole
  collect → envelope pipeline with no cloud account. Doubles as a CI smoke
  fixture (SEC-34/SEC-38).
- `paramify doctor [manifest]` (api.doctor + CLI): preflights Python version,
  the external CLIs each category needs (aws/jq, kubectl, checkov/git), and —
  with a manifest — which secret env vars are set; exits non-zero on gaps.
- README polish: a badge row (CI/license/python/version) and a "Drive it with
  an AI agent" section leaning on --json everywhere, the {ok,errors} manifest
  contract, and the shipped .claude/skills.

Tests: EXPECTED_TOP updated (adds ksi + doctor) + two doctor tests. 209 pass;
ruff + mypy clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Reorder the "how to use it" narrative so the interactive TUI leads, then the
AI-agent path, then the manual CLI — consolidating the scattered usage bits
(command surface, doctor, manifest building, upload) under one "Using the CLI"
section and slimming "How it runs" to architecture.

Also, per review:
- Remove the FedRAMP 20x coverage section (badge + family table + generated
  block). We're not yet confident enough in the KSI mapping to publish it; the
  generator (tools/gen_ksi_coverage.py) now parks gracefully when the README
  markers are absent, ready to resume later. `paramify ksi` still shows live
  numbers internally.
- Remove the "Why the design is strict" section; preserve the pre-1.0 Status
  note by relocating it to the end of "How it runs".

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@21tmccauley
21tmccauley merged commit b950ebd into main Jul 9, 2026
12 checks passed
@21tmccauley
21tmccauley deleted the feat/readme-standouts branch July 10, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant