Expand description
§Seshat CLI
CLI commands and TUI for developer interaction. Provides the human-facing interface to Seshat’s capabilities:
seshat scan <path>— scan a project and display analysis reportseshat serve— start MCP server for AI agent connectionsseshat status— show indexed projects, submodules, and database infoseshat review— interactive TUI for convention review (stub)seshat init— generate MCP configuration for detected AI clients (stub)
Uses clap for argument parsing, indicatif for progress bars, and
tracing-subscriber for log output.
Re-exports§
pub use args::Cli;pub use args::Command;pub use db::find_git_root;pub use db::get_current_branch;pub use error::CliError;pub use format::Verbosity;
Modules§
- args
- Command-line argument definitions (clap derive types).
Command-line argument definitions via
clapderive. - completions
seshat completions— generate shell completion scripts.seshat completions— print a shell completion script to stdout.- config
- Application configuration loading from
seshat.toml. - dangerous_
path - Per-OS dangerous-cwd denylist (see
dangerous_path::is_dangerous_cwd). Dangerous-path denylist forseshat serve. - db
- Shared database path utilities (XDG resolution, project name extraction).
Shared database path utilities used by both
scanandservecommands. - debug
- Debug command: dump conventions with evidence snippets from the DB.
seshat debug-snippetscommand — dumps every convention from the DB with full evidence for offline inspection. - decisions
- Implementation of the
seshat decisionssubcommands. Implementation of theseshat decisionssubcommands. - error
- CLI error types. CLI error types.
- format
- Shared output formatting utilities (color, verbosity, bar charts, etc.). Shared output formatting utilities for CLI reports.
- init
- Implementation of the
seshat initcommand. Implementation of theseshat initcommand. - instructions
- Agent instruction file management (upsert, skill install, hooks).
Agent instruction file management for
seshat init. - report
- Scan report rendering (overview, conventions, next steps). Scan report rendering.
- review
- Implementation of the
seshat reviewcommand. Implementation of theseshat reviewcommand. - scan
- Implementation of the
seshat scancommand. Implementation of theseshat scan <path>command. - serve
- Implementation of the
seshat servecommand. Implementation of theseshat servecommand. - status
- Implementation of the
seshat statuscommand. Implementation of theseshat statuscommand. - tui
- TUI components for interactive convention review.
- uninstall
- Implementation of the
seshat uninstallcommand. Implementation of theseshat uninstallcommand. - update
- Implementation of the
seshat updatecommand. - version_
cache - Version check cache utilities for self-update.
Functions§
- run
- Parse CLI arguments, initialize logging, and dispatch to the appropriate command handler.