Skip to main content

InstallScriptConfig

Struct InstallScriptConfig 

Source
pub struct InstallScriptConfig {
    pub id: Option<String>,
    pub filename: Option<String>,
    pub binaries: Option<Vec<String>>,
    pub repo: Option<String>,
    pub base_url: Option<String>,
    pub verify_checksum: Option<bool>,
    pub install_dir: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub homepage: Option<String>,
    pub skip: Option<StringOrBool>,
}
Expand description

curl | sh installer-script configuration.

Drives the install-script stage, which emits a deterministic POSIX install.sh as a release asset. At run time the script detects the host OS + architecture, maps it to the matching release archive, downloads and sha256-verifies it, extracts the binary, and installs it into an install directory (falling back to $HOME/.local/bin when the primary directory is not writable and no sudo is available).

Every field is optional: the repository slug is derived from the git origin remote, the installed binary names from the project name, the per-platform asset names from the release’s configured targets (via the same engine SSOT that keeps cargo-binstall pkg_url from 404ing), and the checksums filename and tag prefix from the flagship crate that builds the project binary — so a bare install_scripts: {} produces a fully working installer with no required input.

Fields§

§id: Option<String>

Unique identifier for this install-script config (default: “default”).

§filename: Option<String>

Output filename (default: install.sh).

§binaries: Option<Vec<String>>

Binary names to install out of the extracted archive (default: a single-element list of the project name). Every name is installed, so an archive shipping multiple binaries lands them all.

§repo: Option<String>

GitHub owner/name slug the script downloads releases from (default: derived from the git origin remote).

§base_url: Option<String>

Base URL the script downloads releases from and queries the REST API against (default: https://github.com). Point this at a GitHub Enterprise host to install from a self-hosted GitHub; the script derives the API base as <base_url>/api/v3 for any non-github.com host.

§verify_checksum: Option<bool>

Whether the script verifies each download’s sha256 checksum before installing (default: true). Set false only for repos that publish no checksums file or .sha256 sidecars.

§install_dir: Option<String>

Directory the binary is installed into (default: /usr/local/bin). The generated script falls back to $HOME/.local/bin when this directory is not writable and no sudo is available.

§name: Option<String>

Human-readable name rendered into the script’s header banner (default: the project name).

§description: Option<String>

One-line description rendered into the script’s header banner.

§homepage: Option<String>

Project homepage URL rendered into the script’s header banner.

§skip: Option<StringOrBool>

Skip this config. Accepts bool or template string. Accepts the legacy disable: spelling via serde alias for back-compat with imported configs.

Trait Implementations§

Source§

impl Clone for InstallScriptConfig

Source§

fn clone(&self) -> InstallScriptConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for InstallScriptConfig

Source§

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

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

impl Default for InstallScriptConfig

Source§

fn default() -> InstallScriptConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for InstallScriptConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for InstallScriptConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for InstallScriptConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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