Enum SetupAction 

pub enum SetupAction {
    Check {
        target: Utf8PathBuf,
        repo: Option<String>,
        forge: Option<String>,
        required_check: Option<String>,
        json: bool,
    },
    Step {
        name: String,
        target: Utf8PathBuf,
        repo: Option<String>,
        forge: Option<String>,
        required_check: Option<String>,
        apply: bool,
        json: bool,
    },
    Script {
        name: String,
        forge: Option<String>,
    },
}

The setup subcommands.

Variants

Check

Prove the desired state against the forge, mutating nothing.

Fields

target: Utf8PathBuf

The repository to check.

repo: Option<String>

Override the detected project path (owner/name).

forge: Option<String>

Override the detected forge: github or gitlab.

required_check: Option<String>

The check the gate must pass, verified where given.

json: bool

Emit NDJSON events on stdout instead of the human report.

Step

Run one step by name, for recovery and rerun.

Fields

name: String

The step, from rk setup --list.

target: Utf8PathBuf

The repository to set up.

repo: Option<String>

Override the detected project path (owner/name).

forge: Option<String>

Override the detected forge: github or gitlab.

required_check: Option<String>

The check the gate must pass; required on github, refused on gitlab.

apply: bool

Run the step; without it the step is previewed and nothing runs.

json: bool

Emit NDJSON events on stdout instead of the human report.

Script

Print one embedded setup script, for audit.

Fields

name: String

The step whose script to print.

forge: Option<String>

Which forge’s tree to read; defaults to github.

Trait Implementations

impl Debug for SetupAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for SetupAction

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for SetupAction

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand