Struct BuildArgs 

pub struct BuildArgs {

    pub src: Option<PathBuf>,
    pub package: Option<PackageName>,
    pub all_packages: bool,
    pub out_dir: Option<PathBuf>,
    pub sdist: bool,
    pub wheel: bool,
    pub list: bool,
    pub build_logs: bool,
    pub no_build_logs: bool,
    pub force_pep517: bool,
    pub clear: bool,
    pub create_gitignore: bool,
    pub no_create_gitignore: bool,
    pub build_constraints: Vec<Maybe<PathBuf>>,
    pub require_hashes: bool,
    pub no_require_hashes: bool,
    pub verify_hashes: bool,
    pub no_verify_hashes: bool,
    pub python: Option<Maybe<String>>,
    pub resolver: ResolverArgs,
    pub build: BuildOptionsArgs,
    pub refresh: RefreshArgs,
}

Fields

src: Option<PathBuf>

The directory from which distributions should be built, or a source distribution archive to build into a wheel.

Defaults to the current working directory.

package: Option<PackageName>

Build a specific package in the workspace.

The workspace will be discovered from the provided source directory, or the current directory if no source directory is provided.

If the workspace member does not exist, uv will exit with an error.

all_packages: bool

Builds all packages in the workspace.

The workspace will be discovered from the provided source directory, or the current directory if no source directory is provided.

If the workspace member does not exist, uv will exit with an error.

out_dir: Option<PathBuf>

The output directory to which distributions should be written.

Defaults to the dist subdirectory within the source directory, or the directory containing the source distribution archive.

sdist: bool

Build a source distribution (“sdist”) from the given directory.

wheel: bool

Build a binary distribution (“wheel”) from the given directory.

list: bool

When using the uv build backend, list the files that would be included when building.

Skips building the actual distribution, except when the source distribution is needed to build the wheel. The file list is collected directly without a PEP 517 environment. It only works with the uv build backend, there is no PEP 517 file list build hook.

This option can be combined with --sdist and --wheel for inspecting different build paths.

build_logs: bool

no_build_logs: bool

Hide logs from the build backend.

force_pep517: bool

Always build through PEP 517, don’t use the fast path for the uv build backend.

By default, uv won’t create a PEP 517 build environment for packages using the uv build backend, but use a fast path that calls into the build backend directly. This option forces always using PEP 517.

clear: bool

Clear the output directory before the build, removing stale artifacts.

create_gitignore: bool

no_create_gitignore: bool

Do not create a .gitignore file in the output directory.

By default, uv creates a .gitignore file in the output directory to exclude build artifacts from version control. When this flag is used, the file will be omitted.

build_constraints: Vec<Maybe<PathBuf>>

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

Constraints files are requirements.txt-like files that only control the version of a build dependency that’s installed. However, including a package in a constraints file will not trigger the inclusion of that package on its own.

require_hashes: bool

Require a matching hash for each requirement.

By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash.

When --require-hashes is enabled, all requirements must include a hash or set of hashes, and all requirements must either be pinned to exact versions (e.g., ==1.0.0), or be specified via direct URL.

Hash-checking mode introduces a number of additional constraints:

• Git dependencies are not supported.
• Editable installations are not supported.
• Local dependencies are not supported, unless they point to a specific wheel (.whl) or source archive (.zip, .tar.gz), as opposed to a directory.

no_require_hashes: bool

verify_hashes: bool

no_verify_hashes: bool

Disable validation of hashes in the requirements file.

By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash. To enforce hash validation, use --require-hashes.

python: Option<Maybe<String>>

The Python interpreter to use for the build environment.

By default, builds are executed in isolated virtual environments. The discovered interpreter will be used to create those environments, and will be symlinked or copied in depending on the platform.

See uv help python to view supported request formats.

resolver: ResolverArgs

build: BuildOptionsArgs

refresh: RefreshArgs

Trait Implementations

impl Args for BuildArgs

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 BuildArgs

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.