Enum Command 

pub enum Command {
    Init {
        git_hooks: bool,
    },
    Apply {
        dry_run: bool,
    },
    Render {
        check: bool,
        dry_run: bool,
    },
    Link {
        dry_run: bool,
    },
    Unlink {
        paths: Vec<Utf8PathBuf>,
    },
    Status {
        icons: Option<IconsMode>,
        no_color: bool,
    },
    List {
        all: bool,
        icons: Option<IconsMode>,
        no_color: bool,
    },
    Absorb {
        target: Utf8PathBuf,
        dry_run: bool,
        yes: bool,
    },
    Doctor {
        icons: Option<IconsMode>,
        no_color: bool,
    },
    GcBackup {
        older_than: Option<String>,
        dry_run: bool,
        icons: Option<IconsMode>,
        no_color: bool,
    },
    Hooks {
        action: HookAction,
    },
    Update {
        dry_run: bool,
    },
    Unmanaged {
        icons: Option<IconsMode>,
        no_color: bool,
    },
    Diff {
        icons: Option<IconsMode>,
        no_color: bool,
    },
    Secret {
        action: SecretAction,
    },
    SelfUpdate {
        yes: bool,
        check: bool,
        non_interactive: bool,
    },
    Completion {
        shell: Shell,
    },
}

Variants

Init

Initialize source repo skeleton

Fields

git_hooks: bool

Install git pre-commit/pre-push hooks for render-drift check

Apply

Render templates + link targets + auto-absorb (default workflow)

Fields

dry_run: bool

Render

Render templates only

Fields

check: bool

Fail with non-zero exit if rendered output diverges (CI hook)

dry_run: bool

Link

Link / relink targets only

Fields

dry_run: bool

Unlink

Unlink targets

Fields

paths: Vec<Utf8PathBuf>

Status

Show drift status (link-broken / replaced / template-drift)

Fields

icons: Option<IconsMode>

Override [ui] icons mode for this invocation

no_color: bool

Disable color output (also respected via NO_COLOR env)

List

List all src→dst link mappings (mount entries + .yuilink overrides)

Fields

all: bool

Include entries whose when evaluates false on the current host

icons: Option<IconsMode>

Override [ui] icons mode for this invocation

no_color: bool

Disable color output (also respected via NO_COLOR env)

Absorb

Manually absorb a target into source (when auto-absorb skipped).

Prints a unified diff (source vs target) on stderr. Without --yes, prompts on a TTY before writing; off a TTY refuses to act unless --yes is given. --dry-run only shows the diff and exits.

Fields

target: Utf8PathBuf

dry_run: bool

yes: bool

Skip the y/N prompt (still prints the diff).

Doctor

Diagnose environment (symlink capability, source detection, etc)

Fields

icons: Option<IconsMode>

Override [ui] icons mode for this invocation

no_color: bool

Disable color output (also respected via NO_COLOR env)

GcBackup

Garbage-collect old backups under $DOTFILES/.yui/backup/.

With no --older-than, prints every parsed backup with its age + size and exits without deleting (a survey). With --older-than DUR, deletes entries whose timestamp suffix is older than DUR. Backups whose name doesn’t match yui’s <stem>_<YYYYMMDD_HHMMSSfff>[.<ext>] shape are left alone — anything you dropped into .yui/backup/ by hand stays there.

Fields

older_than: Option<String>

Age threshold; e.g. 30d, 2w, 12h, 6mo, 1y. Omit to run a non-destructive survey instead.

dry_run: bool

Preview the deletion (no files removed). Only meaningful when --older-than is also given.

icons: Option<IconsMode>

Override [ui] icons mode for this invocation

no_color: bool

Disable color output (also respected via NO_COLOR env)

Hooks

Manage [[hook]] scripts

Fields

action: HookAction

Update

Pull source repo and re-apply (git pull --ff-only + apply).

Refuses to run with a dirty source tree — pulling on top of uncommitted changes mixes upstream work with the user’s in-progress edits in ways that are easy to get wrong. Commit (or stash) first.

Fields

dry_run: bool

Render templates / link targets in dry-run after the pull.

Unmanaged

List source files NOT claimed by any [[mount.entry]] — yui’s “what’s just sitting in the repo unused?” report. Skips .yui/, .git/, anything matched by .yuiignore, and the repo’s own meta files (config*.toml, .yuilink, .gitignore, .yuiignore, *.tera template sources).

Fields

icons: Option<IconsMode>

Override [ui] icons mode for this invocation

no_color: bool

Disable color output (also respected via NO_COLOR env)

Diff

Print a unified diff for every entry that’s drifted from source — like status but with full content. Render-drift rows show the rendered file vs what the template would produce now; link-drift rows show source vs target.

Fields

icons: Option<IconsMode>

Override [ui] icons mode for this invocation

no_color: bool

Disable color output (also respected via NO_COLOR env)

Secret

Manage secret files (*.age, encrypted with age).

Fields

action: SecretAction

SelfUpdate

Update the yui binary itself to the latest GitHub release.

Detects how yui was installed (cargo install / cargo build dev binary / direct binary download) and picks the right upgrade path. Powered by the shared yukimemi/kaishin library so the behaviour matches rvpm self-update / renri self-update.

Fields

yes: bool

Skip the confirmation prompt.

check: bool

Print whether an update is available and exit without installing.

non_interactive: bool

Bail out instead of prompting when stdin isn’t a tty. Pair with --yes to drive self-update from scripts.

Completion

Generate shell completion script for <shell> to stdout.

Pipe into the right place for your shell, e.g. yui completion bash > ~/.local/share/bash-completion/completions/yui, yui completion zsh > "${fpath[1]}/_yui", yui completion pwsh | Out-String | Invoke-Expression.

Fields

shell: Shell

Target shell (bash / zsh / fish / powershell / elvish).

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.

impl FromArgMatches for Command

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 Command

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