Skip to content

docs: updates documentation to match recent changes - #12

Merged
hali-coding merged 1 commit into
mainfrom
docs/update
Jul 26, 2026
Merged

docs: updates documentation to match recent changes#12
hali-coding merged 1 commit into
mainfrom
docs/update

Conversation

@hali-coding

Copy link
Copy Markdown
Owner

Changelog

All notable changes to this project are documented in this file. The format
is loosely based on Keep a Changelog, and
entries are grouped by Conventional Commits
type.

[Unreleased]

Fix

  • tui: re-bind r to refresh the certificate list on the main screen.
    action_refresh existed but had no Binding wired to it, so the key
    silently did nothing.

Docs

  • readme: document the ssltui get (print/save a cert, key, chain, or
    full bundle) and ssltui audit (print the event log) CLI subcommands,
    which existed but were undocumented.
  • readme: fix the CI workflow link/description — it pointed at the
    non-existent .github/workflows/ci.yml and claimed a push trigger; the
    real workflow is pr.yaml and runs on pull requests against main only.
  • readme: remove the claim that cron can be installed via a TUI "Cron
    Schedule" option — no such feature exists; cron entries are added
    manually.
  • readme: remove the claim that the CA root directory can be switched
    at runtime via a p key in the TUI — no such screen exists; restart with
    a different SSLTUI_DIR/--dir instead.
  • tui: correct the keyboard reference — drop the non-existent p
    (change root dir) binding, add the t (API token) and a (export audit
    log) bindings that were missing, add the cert viewer's k (toggle
    private key) binding, and document the previously-uncovered API server
    screen bindings (t/i/c/q).
  • api: document the 409 Conflict response returned when issuing a
    certificate for a CN that already exists — implemented but previously
    unlisted in both the endpoint docs and the error-response table.
  • claude.md: fix the headless CLI usage examples, which used a
    --renew/--issue/--status flag syntax the CLI has never had; it uses
    renew/issue/status subcommands (plus serve/get/getroot/audit,
    now listed too).
  • claude.md: remove the CA-root-key passphrase requirement — no
    passphrase support exists anywhere in ca.py/tui.py/__main__.py; keys
    are always generated unencrypted.
  • fix two stray --renew-flag references left over in code comments/docstrings
    (ssltui/renewal.py, ssltui/store.py) from before the CLI moved to
    subcommands.

No functional/runtime changes beyond the r keybinding fix — everything
else in this entry brings documentation in README.md, docs/API.md,
docs/TUI.md, and CLAUDE.md back in line with current behavior in
ssltui/.

Copilot AI review requested due to automatic review settings July 26, 2026 07:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates project documentation to match the current CLI/TUI/API behavior, plus a small TUI usability fix by wiring the existing refresh action to a keybinding.

Changes:

  • TUI: bind r on the main screen to the existing action_refresh.
  • Docs: bring README/TUI/API/CLAUDE docs in sync with current CLI subcommands, TUI bindings, and API error responses (including 409 Conflict for duplicate CN).
  • Docs: remove/replace references to non-existent TUI features (changing root dir in-app, “Cron Schedule” option).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
ssltui/tui.py Adds r binding to call action_refresh on the main screen.
ssltui/store.py Updates module docstring to reflect renew subcommand naming.
ssltui/renewal.py Updates docstring to reflect renew subcommand naming.
README.md Documents get/audit, corrects CI workflow reference/trigger, removes non-existent TUI claims.
docs/TUI.md Updates keybinding reference (main screen, cert viewer k, API server screen) and removes non-existent “change dir” feature.
docs/API.md Documents 409 Conflict for duplicate CN issuance and adds it to the error table.
CLAUDE.md Updates CLI examples to subcommand form and corrects CA key passphrase claim.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@hali-coding
hali-coding merged commit 63424d2 into main Jul 26, 2026
6 checks passed
@hali-coding
hali-coding deleted the docs/update branch July 26, 2026 17:33
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.

2 participants