add shell completions

Author: sru-stack9

Cargo.lock

@@ -28,6 +28,12 @@ sqlite-vec = "0.1"
 
 # CLI
 clap = { version = "4", features = ["derive"] }
+clap_complete = "4"
+
+# Interactive CLI (optional, on by default)
+dialoguer = { version = "0.11", features = ["fuzzy-select"], optional = true }
+indicatif = { version = "0.17", optional = true }
+console = { version = "0.15", optional = true }
 
 # Knowledge graph
 petgraph = "0.6"
@@ -60,6 +66,10 @@ hostname = "0.4"
 # Vector byte casting
 zerocopy = "0.8"
 
+[features]
+default = ["interactive"]
+interactive = ["dep:dialoguer", "dep:indicatif", "dep:console"]
+
 [dev-dependencies]
 tokio-test = "0.4"
 tempfile = "3"

Cargo.toml

@@ -1,12 +1,21 @@
 use clap::{Parser, Subcommand};
+use clap_complete::Shell;
 
 #[derive(Parser)]
 #[command(
     name = "smriti",
     version,
-    about = "Smriti — A lightning-fast knowledge store and memory layer for AI agents",
+    about = "smriti — memory layer for your AI agents",
     long_about = "Smriti (Sanskrit: memory) — Self-hosted knowledge store built in Rust for agentic AI.\n\
-                   Features: MCP server, agent memory, knowledge graph, wiki-links, full-text search, sync."
+                   Features: MCP server, agent memory, knowledge graph, wiki-links, full-text search, sync.",
+    after_help = "\x1b[1mExamples:\x1b[0m\n  \
+        smriti create \"Meeting Notes\" -c \"Discussed Q2 roadmap\" -t client,project\n  \
+        smriti new                         # interactive guided note creation\n  \
+        smriti search \"roadmap\" --limit 5\n  \
+        smriti graph --format dot | dot -Tsvg -o graph.svg\n  \
+        smriti serve --port 8080\n  \
+        smriti completions zsh > ~/.zsh/completions/_smriti",
+    styles = styles(),
 )]
 pub struct Cli {
     /// Path to the database file
@@ -19,7 +28,10 @@ pub struct Cli {
 
 #[derive(Subcommand)]
 pub enum Commands {
+    // ── CAPTURE ──────────────────────────────────────────
+
     /// Create a new note
+    #[command(display_order = 1)]
     Create {
         /// Note title
         title: String,
@@ -37,7 +49,15 @@ pub enum Commands {
         tags: Option<Vec<String>>,
     },
 
+    /// Interactive guided note creation
+    #[cfg(feature = "interactive")]
+    #[command(display_order = 2, alias = "n")]
+    New,
+
+    // ── SEARCH ───────────────────────────────────────────
+
     /// Read a note by ID or title
+    #[command(display_order = 10)]
     Read {
         /// Note ID or title
         id: String,
@@ -48,6 +68,7 @@ pub enum Commands {
     },
 
     /// List all notes
+    #[command(display_order = 11)]
     List {
         /// Maximum number of notes to show
         #[arg(long, short, default_value = "20")]
@@ -63,6 +84,7 @@ pub enum Commands {
     },
 
     /// Search notes using full-text search
+    #[command(display_order = 12)]
     Search {
         /// Search query
         query: String,
@@ -76,7 +98,10 @@ pub enum Commands {
         json: bool,
     },
 
+    // ── GRAPH ────────────────────────────────────────────
+
     /// Show the knowledge graph
+    #[command(display_order = 20)]
     Graph {
         /// Output format: json, dot, or text
         #[arg(long, short, default_value = "text")]
@@ -92,9 +117,13 @@ pub enum Commands {
     },
 
     /// Show database statistics
+    #[command(display_order = 21)]
     Stats,
 
+    // ── SERVER ───────────────────────────────────────────
+
     /// Start the REST API server
+    #[command(display_order = 30)]
     Serve {
         /// Host to bind to
         #[arg(long, default_value = "0.0.0.0")]
@@ -106,9 +135,28 @@ pub enum Commands {
     },
 
     /// Start the MCP server (JSON-RPC over stdio)
+    #[command(display_order = 31)]
     Mcp,
 
+    /// Generate shell completion scripts
+    #[command(
+        display_order = 32,
+        after_help = "Install completions:\n  \
+            bash:       smriti completions bash > ~/.bash_completion.d/smriti\n  \
+            zsh:        smriti completions zsh  > ~/.zsh/completions/_smriti\n  \
+            fish:       smriti completions fish > ~/.config/fish/completions/smriti.fish\n  \
+            powershell: smriti completions powershell >> $PROFILE\n  \
+            elvish:     smriti completions elvish > ~/.elvish/lib/smriti.elv"
+    )]
+    Completions {
+        /// Target shell
+        shell: Shell,
+    },
+
+    // ── DATA ─────────────────────────────────────────────
+
     /// Sync notes with a remote server (Synology WebDAV or custom)
+    #[command(display_order = 40)]
     Sync {
         /// Remote URL (e.g., https://nas.local:5006/notes)
         #[arg(long)]
@@ -120,6 +168,7 @@ pub enum Commands {
     },
 
     /// Import notes from a directory of markdown files
+    #[command(display_order = 41)]
     Import {
         /// Directory containing .md files
         path: String,
@@ -130,6 +179,7 @@ pub enum Commands {
     },
 
     /// Export notes to a directory of markdown files
+    #[command(display_order = 42)]
     Export {
         /// Output directory
         path: String,
@@ -139,3 +189,35 @@ pub enum Commands {
         frontmatter: bool,
     },
 }
+
+/// Custom styles for colorized --help output.
+fn styles() -> clap::builder::Styles {
+    use clap::builder::styling::{AnsiColor, Color, Style};
+
+    clap::builder::Styles::styled()
+        .usage(
+            Style::new()
+                .bold()
+                .underline()
+                .fg_color(Some(Color::Ansi(AnsiColor::Yellow))),
+        )
+        .header(
+            Style::new()
+                .bold()
+                .underline()
+                .fg_color(Some(Color::Ansi(AnsiColor::Yellow))),
+        )
+        .literal(
+            Style::new()
+                .fg_color(Some(Color::Ansi(AnsiColor::Cyan))),
+        )
+        .placeholder(
+            Style::new()
+                .fg_color(Some(Color::Ansi(AnsiColor::Green))),
+        )
+        .valid(
+            Style::new()
+                .fg_color(Some(Color::Ansi(AnsiColor::Cyan)))
+                .bold(),
+        )
+}