Struct ToolRunArgs 

pub struct ToolRunArgs {

    pub command: Option<ExternalCommand>,
    pub from: Option<String>,
    pub with: Vec<CommaSeparatedRequirements>,
    pub with_editable: Vec<CommaSeparatedRequirements>,
    pub with_requirements: Vec<Maybe<PathBuf>>,
    pub constraints: Vec<Maybe<PathBuf>>,
    pub build_constraints: Vec<Maybe<PathBuf>>,
    pub overrides: Vec<Maybe<PathBuf>>,
    pub isolated: bool,
    pub env_file: Vec<PathBuf>,
    pub no_env_file: bool,
    pub installer: ResolverInstallerArgs,
    pub build: BuildOptionsArgs,
    pub refresh: RefreshArgs,
    pub lfs: bool,
    pub python: Option<Maybe<String>>,
    pub show_resolution: bool,
    pub python_platform: Option<TargetTriple>,
    pub generate_shell_completion: Option<Shell>,
}

Fields

command: Option<ExternalCommand>

The command to run.

WARNING: The documentation for Self::command is not included in help output

from: Option<String>

Use the given package to provide the command.

By default, the package name is assumed to match the command name.

with: Vec<CommaSeparatedRequirements>

Run with the given packages installed.

with_editable: Vec<CommaSeparatedRequirements>

Run with the given packages installed in editable mode

When used in a project, these dependencies will be layered on top of the uv tool’s environment in a separate, ephemeral environment. These dependencies are allowed to conflict with those specified.

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.

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.

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.

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.

isolated: bool

Run the tool in an isolated virtual environment, ignoring any already-installed tools.

env_file: Vec<PathBuf>

Load environment variables from a .env file.

Can be provided multiple times, with subsequent files overriding values defined in previous files.

no_env_file: bool

Avoid reading environment variables from a .env file.

installer: ResolverInstallerArgs

build: BuildOptionsArgs

refresh: RefreshArgs

lfs: bool

Whether to use Git LFS when adding a dependency from Git.

python: Option<Maybe<String>>

The Python interpreter to use to build the run environment.

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

show_resolution: bool

Whether to show resolver and installer output from any environment modifications.

By default, environment modifications are omitted, but enabled under --verbose.

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.

generate_shell_completion: Option<Shell>

Trait Implementations

impl Args for ToolRunArgs

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 ToolRunArgs

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.