Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
Show 18 variants Install { repo_slug: String, name: Option<String>, tag: Option<String>, kind: Filetype, provider: Option<Provider>, base_url: Option<String>, channel: Channel, match_pattern: Option<String>, exclude_pattern: Option<String>, desktop: bool, trust_mode: TrustMode, dry_run: bool, }, Build { repo_slug: String, name: Option<String>, tag: Option<String>, branch: Option<String>, provider: Option<Provider>, base_url: Option<String>, channel: Channel, desktop: bool, build_profile: Option<BuildProfile>, dry_run: bool, }, Remove { names: Vec<String>, purge: bool, force: bool, dry_run: bool, }, Rollback { action: RollbackAction, }, Reinstall { names: Vec<String>, trust_mode: TrustMode, force: bool, dry_run: bool, }, Upgrade { names: Option<Vec<String>>, force: bool, check: bool, machine_readable: bool, json: bool, trust_mode: TrustMode, dry_run: bool, }, List { name: Option<String>, json: bool, }, Changelog { name: String, from_tag: Option<String>, to_tag: Option<String>, }, Probe { repo_slug: String, provider: Option<Provider>, base_url: Option<String>, channel: Channel, limit: u32, verbose: bool, json: bool, }, Search { query_words: Vec<String>, provider: Option<Provider>, base_url: Option<String>, limit: u32, language: Option<String>, topic: Option<String>, min_stars: Option<u64>, max_stars: Option<u64>, pushed_after: Option<NaiveDate>, include_forks: bool, include_archived: bool, json: bool, }, Find {
Show 19 fields query_words: Vec<String>, provider: Option<Provider>, base_url: Option<String>, limit: u32, language: Option<String>, topic: Option<String>, min_stars: Option<u64>, max_stars: Option<u64>, pushed_after: Option<NaiveDate>, include_forks: bool, include_archived: bool, name: Option<String>, kind: Filetype, channel: Channel, match_pattern: Option<String>, exclude_pattern: Option<String>, desktop: bool, trust_mode: TrustMode, dry_run: bool,
}, Config { action: ConfigAction, }, Package { action: PackageAction, }, Hooks { action: HooksAction, }, Import { path: PathBuf, skip_failed: bool, import_as: Option<ImportAs>, }, Export { path: PathBuf, full: bool, }, Migrate, Doctor { names: Vec<String>, verbose: bool, fix: bool, json: bool, },
}

Variants§

§

Install

Install a package from an upstream release source

Fields

§repo_slug: String

Repository identifier or URL

§name: Option<String>

Name to register the application under (falls back to git repository name when omitted)

§tag: Option<String>

Version tag to install (defaults to latest)

§kind: Filetype

File type to install

§provider: Option<Provider>

Source provider hosting the repository. Defaults to auto-detection.

§base_url: Option<String>

Custom base URL. Defaults to provider’s root

§channel: Channel

Update channel to track

§match_pattern: Option<String>

Match pattern to use as a hint for which asset to prefer

§exclude_pattern: Option<String>

Exclude pattern to filter out unwanted assets (e.g., “rocm”, “debug”)

§desktop: bool

Whether or not to create a .desktop entry for GUI applications

§trust_mode: TrustMode

Trust verification mode for downloaded assets

§dry_run: bool

Preview install resolution without downloading or writing files

§

Build

Build and install from source for release tags without artifacts

Fields

§repo_slug: String

Repository identifier or URL

§name: Option<String>

Name to register the application under (falls back to git repository name when omitted)

§tag: Option<String>

Version tag to build (defaults to latest)

§branch: Option<String>

Branch name to build from (uses latest commit from that branch)

§provider: Option<Provider>

Source provider hosting the repository. Defaults to auto-detection.

§base_url: Option<String>

Custom base URL. Defaults to provider’s root

§channel: Channel

Update channel to track

§desktop: bool

Whether or not to create a .desktop entry for GUI applications

§build_profile: Option<BuildProfile>

Build profile used to compile/install from source (auto-detected when omitted)

§dry_run: bool

Preview build resolution without compiling or writing files

§

Remove

Remove one or more installed packages

Fields

§names: Vec<String>

Names of packages to remove

§purge: bool

Remove all associated cached data

§force: bool

Ignore uninstall errors and remove metadata anyway

§dry_run: bool

Preview removal actions without deleting files or metadata

§

Rollback

Manage stored rollback artifacts

Fields

§

Reinstall

Reinstall one or more packages (remove then install)

Fields

§names: Vec<String>

Names of packages to reinstall

§trust_mode: TrustMode

Trust verification mode for release-asset reinstalls

§force: bool

Ignore uninstall errors and remove metadata anyway before reinstalling

§dry_run: bool

Preview reinstall resolution without removing, building, or writing files

§

Upgrade

Upgrade installed packages to their latest versions

Fields

§names: Option<Vec<String>>

Packages to upgrade (upgrades all if omitted)

§force: bool

Force upgrade even if already up to date

§check: bool

Check for available upgrades without applying them

§machine_readable: bool

Use script-friendly check output: one line per update, “name oldver newver”

§json: bool

Print check results as JSON

§trust_mode: TrustMode

Trust verification mode for downloaded assets

§dry_run: bool

Preview upgrade resolution without downloading or writing files

§

List

List installed packages and their metadata

Fields

§name: Option<String>

Package name for detailed information

§json: bool

Print raw package metadata as JSON

§

Changelog

Show upstream release notes for an installed package

Fields

§name: String

Installed package name

§from_tag: Option<String>

Override the starting release tag

§to_tag: Option<String>

Override the ending release tag

§

Probe

Inspect releases visible from a provider without installing

Fields

§repo_slug: String

Repository identifier or URL to probe

§provider: Option<Provider>

Source provider (defaults to github, or scraper for URLs)

§base_url: Option<String>

Custom base URL for self-hosted providers

§channel: Channel

Channel view to display

§limit: u32

Maximum number of releases to display

§verbose: bool

Include scored candidate assets for each release

§json: bool

Print probe results as JSON

§

Search

Search provider repositories by keyword(s)

Fields

§query_words: Vec<String>

Optional query words (joined with spaces)

§provider: Option<Provider>

Source provider to search (defaults to github)

§base_url: Option<String>

Custom base URL for self-hosted providers

§limit: u32

Maximum number of results to display

§language: Option<String>

Restrict results to repositories with this primary language

§topic: Option<String>

Restrict results to repositories tagged with this topic

§min_stars: Option<u64>

Restrict results to repositories with at least this many stars

§max_stars: Option<u64>

Restrict results to repositories with at most this many stars

§pushed_after: Option<NaiveDate>

Restrict results to repositories pushed on or after YYYY-MM-DD

§include_forks: bool

Include forked repositories in provider search results

§include_archived: bool

Include archived repositories in provider search results

§json: bool

Print search results as JSON

§

Find

Search repositories interactively and install a selected result

Fields

§query_words: Vec<String>

Query words (joined with spaces)

§provider: Option<Provider>

Source provider to search (defaults to github)

§base_url: Option<String>

Custom base URL for self-hosted providers

§limit: u32

Maximum number of results to display

§language: Option<String>

Restrict results to repositories with this primary language

§topic: Option<String>

Restrict results to repositories tagged with this topic

§min_stars: Option<u64>

Restrict results to repositories with at least this many stars

§max_stars: Option<u64>

Restrict results to repositories with at most this many stars

§pushed_after: Option<NaiveDate>

Restrict results to repositories pushed on or after YYYY-MM-DD

§include_forks: bool

Include forked repositories in provider search results

§include_archived: bool

Include archived repositories in provider search results

§name: Option<String>

Package name to register without prompting

§kind: Filetype

File type to install

§channel: Channel

Update channel to track

§match_pattern: Option<String>

Match pattern to use as a hint for which asset to prefer

§exclude_pattern: Option<String>

Exclude pattern to filter out unwanted assets (e.g., “rocm”, “debug”)

§desktop: bool

Whether or not to create a .desktop entry for GUI applications

§trust_mode: TrustMode

Trust verification mode for downloaded assets

§dry_run: bool

Preview install resolution without downloading or writing files

§

Config

Manage upstream configuration

Fields

§

Package

Manage package-specific behavior

Fields

§

Hooks

Manage shell integration hooks and local upstream data

Fields

§

Import

Import trusted keys, package metadata manifests, or full snapshots

Fields

§path: PathBuf

Path to a keys file, metadata manifest, or snapshot archive

§skip_failed: bool

Continue importing remaining entries when metadata manifest processing fails

§import_as: Option<ImportAs>

Force the input type instead of autodetection

§

Export

Export packages to a manifest or full snapshot

Fields

§path: PathBuf

Output path for the manifest or snapshot archive

§full: bool

Export a full snapshot of the upstream directory instead of a manifest

§

Migrate

Migrate local upstream data after breaking changes

§

Doctor

Run diagnostics to detect installation and integration issues

Fields

§names: Vec<String>

Package names to check (all installed packages if omitted)

§verbose: bool

Print each check result line in addition to summary output

§fix: bool

Attempt automatic repairs for detected issues

§json: bool

Print diagnostic report as JSON

Implementations§

Trait Implementations§

Source§

impl Display 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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