Skip to main content

release_kit/cli/
guide.rs

1//! Arguments for `rk guide`.
2
3use clap::Args;
4
5/// Print a runbook with what detection knows filled in, or list them.
6#[derive(Debug, Args)]
7pub struct GuideArgs {
8    /// The runbook to print; omit it and pass --list to see the names.
9    pub name: Option<String>,
10
11    /// List the runbooks instead of printing one.
12    #[arg(long)]
13    pub list: bool,
14
15    /// Select the technology's lines where the runbook branches; defaults
16    /// to detection from the version file.
17    #[arg(long)]
18    pub tech: Option<String>,
19
20    /// Select the forge's lines where the runbook branches; defaults to
21    /// detection from the git remote.
22    #[arg(long)]
23    pub forge: Option<String>,
24
25    /// The project path substituted for <repo>; defaults to detection from
26    /// the git remote.
27    #[arg(long)]
28    pub repo: Option<String>,
29}