docs: updates documentation to match recent changes - #12
Merged
Conversation
Contributor
There was a problem hiding this comment.
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
ron the main screen to the existingaction_refresh. - Docs: bring README/TUI/API/CLAUDE docs in sync with current CLI subcommands, TUI bindings, and API error responses (including
409 Conflictfor 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
rto refresh the certificate list on the main screen.action_refreshexisted but had noBindingwired to it, so the keysilently did nothing.
Docs
ssltui get(print/save a cert, key, chain, orfull bundle) and
ssltui audit(print the event log) CLI subcommands,which existed but were undocumented.
non-existent
.github/workflows/ci.ymland claimed a push trigger; thereal workflow is
pr.yamland runs on pull requests againstmainonly.Schedule" option — no such feature exists; cron entries are added
manually.
at runtime via a
pkey in the TUI — no such screen exists; restart witha different
SSLTUI_DIR/--dirinstead.p(change root dir) binding, add the
t(API token) anda(export auditlog) bindings that were missing, add the cert viewer's
k(toggleprivate key) binding, and document the previously-uncovered API server
screen bindings (
t/i/c/q).409 Conflictresponse returned when issuing acertificate for a CN that already exists — implemented but previously
unlisted in both the endpoint docs and the error-response table.
--renew/--issue/--statusflag syntax the CLI has never had; it usesrenew/issue/statussubcommands (plusserve/get/getroot/audit,now listed too).
passphrase support exists anywhere in
ca.py/tui.py/__main__.py; keysare always generated unencrypted.
--renew-flag references left over in code comments/docstrings(
ssltui/renewal.py,ssltui/store.py) from before the CLI moved tosubcommands.
No functional/runtime changes beyond the
rkeybinding fix — everythingelse in this entry brings documentation in
README.md,docs/API.md,docs/TUI.md, andCLAUDE.mdback in line with current behavior inssltui/.