Struct ToolUpgradeArgs 

pub struct ToolUpgradeArgs {

    pub name: Vec<String>,
    pub all: bool,
    pub python: Option<Maybe<String>>,
    pub python_platform: Option<TargetTriple>,
    pub upgrade: bool,
    pub upgrade_package: Vec<Requirement<VerbatimParsedUrl>>,
    pub index_args: IndexArgs,
    pub reinstall: bool,
    pub no_reinstall: bool,
    pub reinstall_package: Vec<PackageName>,
    pub index_strategy: Option<IndexStrategy>,
    pub keyring_provider: Option<KeyringProviderType>,
    pub resolution: Option<ResolutionMode>,
    pub prerelease: Option<PrereleaseMode>,
    pub pre: bool,
    pub fork_strategy: Option<ForkStrategy>,
    pub config_setting: Option<Vec<ConfigSettingEntry>>,
    pub config_setting_package: Option<Vec<ConfigSettingPackageEntry>>,
    pub no_build_isolation: bool,
    pub no_build_isolation_package: Vec<PackageName>,
    pub build_isolation: bool,
    pub exclude_newer: Option<ExcludeNewerValue>,
    pub exclude_newer_package: Option<Vec<ExcludeNewerPackageEntry>>,
    pub link_mode: Option<LinkMode>,
    pub compile_bytecode: bool,
    pub no_compile_bytecode: bool,
    pub no_sources: bool,
    pub build: BuildOptionsArgs,
}

Fields

name: Vec<String>

The name of the tool to upgrade, along with an optional version specifier.

all: bool

Upgrade all tools.

python: Option<Maybe<String>>

Upgrade a tool, and specify it to use the given Python interpreter to build its environment. Use with --all to apply to all tools.

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.

upgrade: bool

Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh.

upgrade_package: Vec<Requirement<VerbatimParsedUrl>>

Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package.

index_args: IndexArgs

reinstall: bool

Reinstall all packages, regardless of whether they’re already installed. Implies --refresh.

no_reinstall: bool

reinstall_package: Vec<PackageName>

Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package.

index_strategy: Option<IndexStrategy>

The strategy to use when resolving against multiple index URLs.

By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents “dependency confusion” attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

keyring_provider: Option<KeyringProviderType>

Attempt to use keyring for authentication for index URLs.

At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

Defaults to disabled.

resolution: Option<ResolutionMode>

The strategy to use when selecting between the different compatible versions for a given package requirement.

By default, uv will use the latest compatible version of each package (highest).

prerelease: Option<PrereleaseMode>

The strategy to use when considering pre-release versions.

By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

pre: bool

fork_strategy: Option<ForkStrategy>

The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

Under fewest, uv will minimize the number of selected versions for each package, preferring older versions that are compatible with a wider range of supported Python versions or platforms.

config_setting: Option<Vec<ConfigSettingEntry>>

Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs.

config_setting_package: Option<Vec<ConfigSettingPackageEntry>>

Settings to pass to the PEP 517 build backend for a specific package, specified as PACKAGE:KEY=VALUE pairs.

no_build_isolation: bool

Disable isolation when building source distributions.

Assumes that build dependencies specified by PEP 518 are already installed.

no_build_isolation_package: Vec<PackageName>

Disable isolation when building source distributions for a specific package.

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

build_isolation: bool

exclude_newer: Option<ExcludeNewerValue>

Limit candidate packages to those that were uploaded prior to the given date.

Accepts RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z), local dates in the same format (e.g., 2006-12-02) resolved based on your system’s configured time zone, a “friendly” duration (e.g., 24 hours, 1 week, 30 days), or an ISO 8601 duration (e.g., PT24H, P7D, P30D).

Durations do not respect semantics of the local time zone and are always resolved to a fixed number of seconds assuming that a day is 24 hours (e.g., DST transitions are ignored). Calendar units such as months and years are not allowed.

exclude_newer_package: Option<Vec<ExcludeNewerPackageEntry>>

Limit candidate packages for specific packages to those that were uploaded prior to the given date.

Accepts package-date pairs in the format PACKAGE=DATE, where DATE is an RFC 3339 timestamp (e.g., 2006-12-02T02:07:43Z), a local date in the same format (e.g., 2006-12-02) resolved based on your system’s configured time zone, a “friendly” duration (e.g., 24 hours, 1 week, 30 days), or an ISO 8601 duration (e.g., PT24H, P7D, P30D).

Durations do not respect semantics of the local time zone and are always resolved to a fixed number of seconds assuming that a day is 24 hours (e.g., DST transitions are ignored). Calendar units such as months and years are not allowed.

Can be provided multiple times for different packages.

link_mode: Option<LinkMode>

The method to use when installing packages from the global cache.

Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

compile_bytecode: bool

Compile Python files to bytecode after installation.

By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

no_compile_bytecode: bool

no_sources: bool

Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources.

build: BuildOptionsArgs

Trait Implementations

impl Args for ToolUpgradeArgs

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 ToolUpgradeArgs

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.