Struct ToolInstallArgs 

pub struct ToolInstallArgs {

    pub package: String,
    pub from: Option<String>,
    pub with: Vec<CommaSeparatedRequirements>,
    pub with_requirements: Vec<Maybe<PathBuf>>,
    pub editable: bool,
    pub with_editable: Vec<CommaSeparatedRequirements>,
    pub with_executables_from: Vec<CommaSeparatedRequirements>,
    pub constraints: Vec<Maybe<PathBuf>>,
    pub overrides: Vec<Maybe<PathBuf>>,
    pub excludes: Vec<Maybe<PathBuf>>,
    pub build_constraints: Vec<Maybe<PathBuf>>,
    pub installer: ResolverInstallerArgs,
    pub build: BuildOptionsArgs,
    pub refresh: RefreshArgs,
    pub force: bool,
    pub python: Option<Maybe<String>>,
    pub python_platform: Option<TargetTriple>,
}

Fields

package: String

The package to install commands from.

from: Option<String>

The package to install commands from.

This option is provided for parity with uv tool run, but is redundant with package.

with: Vec<CommaSeparatedRequirements>

Include the following additional requirements.

with_requirements: Vec<Maybe<PathBuf>>

Run with the packages listed in the given files.

The following formats are supported: requirements.txt, .py files with inline metadata, and pylock.toml.

editable: bool

Install the target package in editable mode, such that changes in the package’s source directory are reflected without reinstallation.

with_editable: Vec<CommaSeparatedRequirements>

Include the given packages in editable mode.

with_executables_from: Vec<CommaSeparatedRequirements>

Install executables from the following packages.

constraints: Vec<Maybe<PathBuf>>

Constrain versions using the given requirements files.

Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

This is equivalent to pip’s --constraint option.

overrides: Vec<Maybe<PathBuf>>

Override versions using the given requirements files.

Overrides files are requirements.txt-like files that force a specific version of a requirement to be installed, regardless of the requirements declared by any constituent package, and regardless of whether this would be considered an invalid resolution.

While constraints are additive, in that they’re combined with the requirements of the constituent packages, overrides are absolute, in that they completely replace the requirements of the constituent packages.

excludes: Vec<Maybe<PathBuf>>

Exclude packages from resolution using the given requirements files.

Excludes files are requirements.txt-like files that specify packages to exclude from the resolution. When a package is excluded, it will be omitted from the dependency list entirely and its own dependencies will be ignored during the resolution phase. Excludes are unconditional in that requirement specifiers and markers are ignored; any package listed in the provided file will be omitted from all resolved environments.

build_constraints: Vec<Maybe<PathBuf>>

Constrain build dependencies using the given requirements files when building source distributions.

Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

installer: ResolverInstallerArgs

build: BuildOptionsArgs

refresh: RefreshArgs

force: bool

Force installation of the tool.

Will replace any existing entry points with the same name in the executable directory.

python: Option<Maybe<String>>

The Python interpreter to use to build the tool environment.

See uv help python for details on Python discovery and supported request formats.

python_platform: Option<TargetTriple>

The platform for which requirements should be installed.

Represented as a “target triple”, a string that describes the target platform in terms of its CPU, vendor, and operating system name, like x86_64-unknown-linux-gnu or aarch64-apple-darwin.

When targeting macOS (Darwin), the default minimum version is 13.0. Use MACOSX_DEPLOYMENT_TARGET to specify a different minimum version, e.g., 14.0.

When targeting iOS, the default minimum version is 13.0. Use IPHONEOS_DEPLOYMENT_TARGET to specify a different minimum version, e.g., 14.0.

When targeting Android, the default minimum Android API level is 24. Use ANDROID_API_LEVEL to specify a different minimum version, e.g., 26.

WARNING: When specified, uv will select wheels that are compatible with the target platform; as a result, the installed distributions may not be compatible with the current platform. Conversely, any distributions that are built from source may be incompatible with the target platform, as they will be built for the current platform. The --python-platform option is intended for advanced use cases.

Trait Implementations

impl Args for ToolInstallArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

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

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

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

impl FromArgMatches for ToolInstallArgs

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.