Struct InitArgs 

pub struct InitArgs {

    pub path: Option<PathBuf>,
    pub name: Option<PackageName>,
    pub bare: bool,
    pub virtual: bool,
    pub package: bool,
    pub no_package: bool,
    pub app: bool,
    pub lib: bool,
    pub script: bool,
    pub description: Option<String>,
    pub no_description: bool,
    pub vcs: Option<VersionControlSystem>,
    pub build_backend: Option<ProjectBuildBackend>,
    pub no_readme: bool,
    pub author_from: Option<AuthorFrom>,
    pub no_pin_python: bool,
    pub pin_python: bool,
    pub no_workspace: bool,
    pub python: Option<Maybe<String>>,
    /* private fields */
}

Fields

path: Option<PathBuf>

The path to use for the project/script.

Defaults to the current working directory when initializing an app or library; required when initializing a script. Accepts relative and absolute paths.

If a pyproject.toml is found in any of the parent directories of the target path, the project will be added as a workspace member of the parent, unless --no-workspace is provided.

name: Option<PackageName>

The name of the project.

Defaults to the name of the directory.

bare: bool

Only create a pyproject.toml.

Disables creating extra files like README.md, the src/ tree, .python-version files, etc.

virtual: bool

Create a virtual project, rather than a package.

This option is deprecated and will be removed in a future release.

package: bool

Set up the project to be built as a Python package.

Defines a [build-system] for the project.

This is the default behavior when using --lib or --build-backend.

When using --app, this will include a [project.scripts] entrypoint and use a src/ project structure.

no_package: bool

Do not set up the project to be built as a Python package.

Does not include a [build-system] for the project.

This is the default behavior when using --app.

app: bool

Create a project for an application.

This is the default behavior if --lib is not requested.

This project kind is for web servers, scripts, and command-line interfaces.

By default, an application is not intended to be built and distributed as a Python package. The --package option can be used to create an application that is distributable, e.g., if you want to distribute a command-line interface via PyPI.

lib: bool

Create a project for a library.

A library is a project that is intended to be built and distributed as a Python package.

script: bool

Create a script.

A script is a standalone file with embedded metadata enumerating its dependencies, along with any Python version requirements, as defined in the PEP 723 specification.

PEP 723 scripts can be executed directly with uv run.

By default, adds a requirement on the system Python version; use --python to specify an alternative Python version requirement.

description: Option<String>

Set the project description.

no_description: bool

Disable the description for the project.

vcs: Option<VersionControlSystem>

Initialize a version control system for the project.

By default, uv will initialize a Git repository (git). Use --vcs none to explicitly avoid initializing a version control system.

build_backend: Option<ProjectBuildBackend>

Initialize a build-backend of choice for the project.

Implicitly sets --package.

no_readme: bool

Do not create a README.md file.

author_from: Option<AuthorFrom>

Fill in the authors field in the pyproject.toml.

By default, uv will attempt to infer the author information from some sources (e.g., Git) (auto). Use --author-from git to only infer from Git configuration. Use --author-from none to avoid inferring the author information.

no_pin_python: bool

Do not create a .python-version file for the project.

By default, uv will create a .python-version file containing the minor version of the discovered Python interpreter, which will cause subsequent uv commands to use that version.

pin_python: bool

Create a .python-version file for the project.

This is the default.

no_workspace: bool

Avoid discovering a workspace and create a standalone project.

By default, uv searches for workspaces in the current directory or any parent directory.

python: Option<Maybe<String>>

The Python interpreter to use to determine the minimum supported Python version.

See uv help python to view supported request formats.

Trait Implementations

impl Args for InitArgs

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 InitArgs

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.