diff --git a/crates/miroir-ctl/src/commands/alias.rs b/crates/miroir-ctl/src/commands/alias.rs index 2e7ec3a..5b9d1af 100644 --- a/crates/miroir-ctl/src/commands/alias.rs +++ b/crates/miroir-ctl/src/commands/alias.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Manage index aliases", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/alias.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum AliasSubcommand { /// Create a new alias Create, diff --git a/crates/miroir-ctl/src/commands/canary.rs b/crates/miroir-ctl/src/commands/canary.rs index 6d28ffe..f1dd39f 100644 --- a/crates/miroir-ctl/src/commands/canary.rs +++ b/crates/miroir-ctl/src/commands/canary.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Manage canary deployments", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/canary.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum CanarySubcommand { /// Create a canary deployment Create, diff --git a/crates/miroir-ctl/src/commands/cdc.rs b/crates/miroir-ctl/src/commands/cdc.rs index b425e6b..e3a6f77 100644 --- a/crates/miroir-ctl/src/commands/cdc.rs +++ b/crates/miroir-ctl/src/commands/cdc.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Manage change data capture", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/cdc.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum CdcSubcommand { /// Create a CDC subscription Create, diff --git a/crates/miroir-ctl/src/commands/dump.rs b/crates/miroir-ctl/src/commands/dump.rs index f1804e1..c5953e7 100644 --- a/crates/miroir-ctl/src/commands/dump.rs +++ b/crates/miroir-ctl/src/commands/dump.rs @@ -2,6 +2,7 @@ use clap::Subcommand; use reqwest::Client; #[derive(Subcommand, Debug)] +#[command(about = "Dump and inspect data", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/dump.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum DumpSubcommand { /// Import a Meilisearch dump file into Miroir /// diff --git a/crates/miroir-ctl/src/commands/explain.rs b/crates/miroir-ctl/src/commands/explain.rs index a0aec6c..d59dff0 100644 --- a/crates/miroir-ctl/src/commands/explain.rs +++ b/crates/miroir-ctl/src/commands/explain.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Explain query plans", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/explain.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum ExplainSubcommand { /// Explain a query plan or operation Query { diff --git a/crates/miroir-ctl/src/commands/key.rs b/crates/miroir-ctl/src/commands/key.rs index f8f9f60..912b376 100644 --- a/crates/miroir-ctl/src/commands/key.rs +++ b/crates/miroir-ctl/src/commands/key.rs @@ -10,6 +10,7 @@ use std::io::{self, Write}; /// Key management commands. #[derive(Subcommand, Debug)] +#[command(about = "Manage API keys", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/key.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum KeySubcommand { /// Rotate the admin-scoped nodeMasterKey (zero-downtime). /// diff --git a/crates/miroir-ctl/src/commands/node.rs b/crates/miroir-ctl/src/commands/node.rs index b700363..ce3cbaa 100644 --- a/crates/miroir-ctl/src/commands/node.rs +++ b/crates/miroir-ctl/src/commands/node.rs @@ -9,6 +9,7 @@ use serde_json::json; use std::time::Duration; #[derive(Subcommand, Debug)] +#[command(about = "Manage cluster nodes", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/node.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum NodeSubcommand { /// Add a new node to the cluster Add(AddNodeArgs), diff --git a/crates/miroir-ctl/src/commands/rebalance.rs b/crates/miroir-ctl/src/commands/rebalance.rs index 91166ed..edc5272 100644 --- a/crates/miroir-ctl/src/commands/rebalance.rs +++ b/crates/miroir-ctl/src/commands/rebalance.rs @@ -9,6 +9,7 @@ use std::time::Duration; use tokio::time::sleep as tokio_sleep; #[derive(Subcommand, Debug)] +#[command(about = "Manage rebalancing operations", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/rebalance.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum RebalanceSubcommand { /// Show rebalancing status Status { diff --git a/crates/miroir-ctl/src/commands/reshard.rs b/crates/miroir-ctl/src/commands/reshard.rs index ab1ff6c..ba96545 100644 --- a/crates/miroir-ctl/src/commands/reshard.rs +++ b/crates/miroir-ctl/src/commands/reshard.rs @@ -4,6 +4,7 @@ use clap::Subcommand; use miroir_core::reshard::{check_window_now, ReshardingConfig, WindowGuardResult}; #[derive(Subcommand, Debug)] +#[command(about = "Manage resharding operations", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/reshard.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum ReshardSubcommand { /// Start an online resharding operation (plan ยง13.1). /// diff --git a/crates/miroir-ctl/src/commands/shadow.rs b/crates/miroir-ctl/src/commands/shadow.rs index bd8b79e..f789b5e 100644 --- a/crates/miroir-ctl/src/commands/shadow.rs +++ b/crates/miroir-ctl/src/commands/shadow.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Manage shadow indexing", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/shadow.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum ShadowSubcommand { /// Create a shadow index Create, diff --git a/crates/miroir-ctl/src/commands/status.rs b/crates/miroir-ctl/src/commands/status.rs index 9e3bcde..a1497e9 100644 --- a/crates/miroir-ctl/src/commands/status.rs +++ b/crates/miroir-ctl/src/commands/status.rs @@ -5,6 +5,7 @@ use std::time::Duration; use tokio::time::sleep as tokio_sleep; #[derive(Parser, Debug)] +#[command(about = "Show cluster status and health", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/status.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub struct StatusSubcommand { /// Watch mode: continuously refresh status #[arg(short, long)] diff --git a/crates/miroir-ctl/src/commands/task.rs b/crates/miroir-ctl/src/commands/task.rs index ddaaba9..7c9026f 100644 --- a/crates/miroir-ctl/src/commands/task.rs +++ b/crates/miroir-ctl/src/commands/task.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Monitor and manage background tasks", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/task.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum TaskSubcommand { /// Show all background tasks List, diff --git a/crates/miroir-ctl/src/commands/tenant.rs b/crates/miroir-ctl/src/commands/tenant.rs index 3956530..e0cb407 100644 --- a/crates/miroir-ctl/src/commands/tenant.rs +++ b/crates/miroir-ctl/src/commands/tenant.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Manage multi-tenancy", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/tenant.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum TenantSubcommand { /// Create a new tenant Create, diff --git a/crates/miroir-ctl/src/commands/ttl.rs b/crates/miroir-ctl/src/commands/ttl.rs index 5ec430a..2160ea1 100644 --- a/crates/miroir-ctl/src/commands/ttl.rs +++ b/crates/miroir-ctl/src/commands/ttl.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Manage TTL policies", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/ttl.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum TtlSubcommand { /// Set a TTL policy Set, diff --git a/crates/miroir-ctl/src/commands/ui.rs b/crates/miroir-ctl/src/commands/ui.rs index e26f90d..7a915ea 100644 --- a/crates/miroir-ctl/src/commands/ui.rs +++ b/crates/miroir-ctl/src/commands/ui.rs @@ -7,6 +7,7 @@ use std::io::{self, Write}; use std::process::Command; #[derive(Subcommand, Debug)] +#[command(about = "Launch the web UI", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/ui.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum UiSubcommand { /// Launch the web UI Launch { diff --git a/crates/miroir-ctl/src/commands/verify.rs b/crates/miroir-ctl/src/commands/verify.rs index b6280de..921ece5 100644 --- a/crates/miroir-ctl/src/commands/verify.rs +++ b/crates/miroir-ctl/src/commands/verify.rs @@ -1,6 +1,7 @@ use clap::Subcommand; #[derive(Subcommand, Debug)] +#[command(about = "Verify data integrity", after_help = "Runbooks: https://github.com/jedarden/miroir/blob/main/docs/ctl/verify.md\n\nSee `miroir-ctl help` for a list of all subcommands.")] pub enum VerifySubcommand { /// Verify data integrity for a key prefix Check {