✨ feat(cli): add installable ssm-cli workflow and product docs#23
Merged
Conversation
Implement a full Click + Rich CLI package (ssm_cli) with:\n- configure/login/auth set-token/logout/setup/run/whoami\n- secrets download and FIFO mount\n- profile management\n- deterministic resolution precedence\n- keyring-first token storage with file fallback\n- API client wrapper, retries, and cache/offline fallback\n\nAdd CLI-focused unit tests and wire the console script in pyproject/uv lock.\n\nUpdate documentation with full CLI and first-time setup guides and remove repository wiki page references.
Updated the first-time setup guide to clarify API-only deployment instructions and added a note about using the API for sign-in.
Refactor root README into product-facing documentation only and move developer workflows into dedicated developer docs.\n\nAdd docs/DEVELOPER_GUIDE.md, update development references, and switch CLI documentation to UVX-first commands for running outside repository directories.\n\nAlso harden mypy configuration to ignore build artifacts generated during UVX package builds.
Expose as a first-class console script while keeping as a backward-compatible alias.\n\nUpdate product, CLI, onboarding, and developer documentation to use UVX with so users can run the CLI outside repository directories.\n\nKeep mypy excludes for generated build artifacts to avoid duplicate-module failures during local packaging workflows.
Restructure product and supporting docs around install-once CLI usage with uv tools, plus clear auth/use flows for backend access.\n\nMake documentation branch-agnostic by removing feature-branch references and defaulting to mainline-safe install instructions.\n\nUpdate root README, CLI reference, first-time setup, developer guides, Docker runtime docs, and frontend README for consistency.
Document how to update an existing ssm-cli installation () and how to force reinstall from Git when needed.\n\nAdd explicit Docker Compose update instructions for both prebuilt-image deployments ( + ) and source rebuild deployments (Already up to date. + ).
Add repository knowledge notes plus conventional commit workflow guidance to AGENTS.md.
Updated README to improve clarity and organization of content, including sections on getting started, CLI installation, and contributing.
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.
This PR adds an installable ssm-cli entrypoint and aligns the documentation set around a clear product-first flow: deploy the backend/frontend bundle with Docker Compose, install and run the CLI from anywhere with uv tooling, authenticate and operate against the backend, and update both existing CLI installations and existing Docker deployments with explicit commands while keeping all guidance branch-agnostic and consistent with KISS/DRY principles.