Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
Show 23 variants ShellRender { target: String, }, Init(InitCommand), Shell { command: ShellCommands, }, App { command: AppCommands, }, Install { target: String, replace_managed: bool, yes: bool, }, Uninstall { target: String, force: bool, purge: bool, dry_run: bool, yes: bool, }, Completions { command: CompletionCommands, }, List { available: bool, kind: Option<ResourceKind>, }, Info { target: String, diff: bool, verbose: bool, run_generators: bool, }, Preset { command: PresetCommands, }, Update(UpdateCommand), Upgrade(UpgradeCommand), State { command: StateCommands, }, Self_ { command: SelfCommands, }, Serve { command: ServeCommands, }, Env { command: EnvCommands, }, Sys { command: SysCommands, }, Theme { command: ThemeCommands, }, Ssh { remote_shell: RemoteShell, with: Vec<String>, with_secret: Vec<String>, secret_broker: bool, secret_broker_policy: Vec<PathBuf>, allow_secret: Vec<String>, trust_remote_session: bool, secret_broker_inspect: bool, secret_broker_enroll: bool, trust_remote_metadata: bool, secret_broker_update_policy: Option<String>, args: Vec<String>, }, Local { command: LocalCommands, }, Task { command: TaskCommands, }, Trust { command: TrustCommands, }, Run(TaskRunCommand),
}

Variants§

§

ShellRender

Fields

§target: String
§

Init(InitCommand)

Initialize the current directory as a shine presets directory

§

Shell

Manage shell command presets

Fields

§

App

Manage application configuration presets

Fields

§command: AppCommands
§

Install

Install or repair one shell or app preset

Fields

§target: String

Preset target: app/, shell/[/], or a unique category name

§replace_managed: bool

Replace user-modified files that are already managed by shine

§yes: bool

Approve the displayed lifecycle Plan without prompting

§

Uninstall

Uninstall one shell or app preset

Fields

§target: String

Preset target: app/, shell/[/], or a unique category name

§force: bool

Remove managed files even when they were modified after installation (app only)

§purge: bool

Also remove empty managed preset directories

§dry_run: bool

Print what would be removed without changing anything

§yes: bool

Approve the displayed lifecycle Plan without prompting

§

Completions

Generate or install shell completion scripts

Fields

§

List

List installed resources, or browse available resources with –available

Fields

§available: bool

List available resources instead of installed resources

§kind: Option<ResourceKind>

Limit –available output to app, shell, or sys resources

§

Info

Show details for an available or installed app/shell target, or sys/<ITEM>

Fields

§target: String

Installed item to inspect (e.g. git, starship, proxy, setproxy)

§diff: bool

Also print a unified diff against the expected content

§verbose: bool

Also print the installed or rendered file content

§run_generators: bool

Explicitly execute App generators while evaluating installed content

§

Preset

Manage preset sources, overlays, exports, and Git synchronization

Fields

§

Update(UpdateCommand)

Check managed configuration and shine release updates

§

Upgrade(UpgradeCommand)

Apply available managed configuration updates

§

State

Manage shine-owned runtime state

Fields

§

Self_

Manage the shine binary itself

Fields

§

Serve

Serve shine-managed HTTP resources from ~/.shine/http

Fields

§

Env

Manage preset variables and workspace command environments

Fields

§command: EnvCommands
§

Sys

Manage system bootstrap and configuration for the current OS

Fields

§command: SysCommands
§

Theme

Resolve and sync the terminal’s light/dark theme (see shine theme sync)

Fields

§

Ssh

Open an interactive SSH session with a session-scoped file transfer channel

Fields

§remote_shell: RemoteShell

Remote command shell (must appear before the SSH destination). Windows mode injects environment variables only; shine local is unavailable.

§with: Vec<String>

Inject a plaintext config env value as KEY or KEY=ALIAS (repeatable; must appear before the SSH destination)

§with_secret: Vec<String>

Decrypt KEY_SECRET and inject it as KEY or ALIAS (repeatable; must appear before the SSH destination)

§secret_broker: bool

Enable the session-scoped, on-demand secret broker

§secret_broker_policy: Vec<PathBuf>

Merge an additional local broker policy file (repeatable). The same ownership, permission, and symlink checks apply.

§allow_secret: Vec<String>

Allow one encrypted local config key to be requested by a direct broker command (repeatable; requires local confirmation per request)

§trust_remote_session: bool

Trust the entire remote session and auto-approve matching workspace policies. Never applies to direct –allow-secret requests.

§secret_broker_inspect: bool

Inspect one remote workspace broker description without writing a policy or releasing secrets

§secret_broker_enroll: bool

Enroll one policy from explicitly trusted remote metadata; never decrypts or runs the described command

§trust_remote_metadata: bool

Required acknowledgement that enrollment trusts remote metadata

§secret_broker_update_policy: Option<String>

Replace this existing local policy from the trusted remote description instead of creating a new policy

§args: Vec<String>

ssh options, the destination, and an optional remote command (passed through to the system ssh binary; see ssh(1))

§

Local

Transfer files between this machine and the other end of a shine ssh session

Fields

§

Task

Save, run, and manage personal shortcut commands

Fields

§

Trust

Review and manage target-scoped trust for external Preset code

Fields

§

Run(TaskRunCommand)

Run a saved task (alias for shine task run)

Trait Implementations§

Source§

impl Debug for Commands

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Commands

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Subcommand for Commands

Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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 Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

fn if_supports_color<'a, Out, ApplyFn>( &'a self, stream: impl Into<Stream>, apply: ApplyFn, ) -> SupportsColorsDisplay<'a, Self, Out, ApplyFn>
where ApplyFn: Fn(&'a Self) -> Out,

Apply a given transformation function to all formatters if the given stream supports at least basic ANSI colors, allowing you to conditionally apply given styles/colors. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more