Skip to main content

modular install

Installs a Modular package.

Synopsis

modular install [options] <package>

Description

Installs a package such as the Mojo SDK. The package can be either a Modular-hosted package name (such as mojo), a fully-qualified URL for a TUF manifest repo, or a path to a local manifest repo. For normal installs, you'll always use a Modular-hosted package name. For example:

modular install mojo

Only very rare situations require a URL or path to a TUF manifest repo.

Options

Install options

--arch <ARCH>

Specifies the target architecture.

--cpu <CPU>

Specifies the target CPU.

--dry-run

Prints the CAS IDs for the objects that would be downloaded, but does not actually perform any downloads.

--package-folder <PACKAGE_FOLDER>

Forces the local package folder name. Package folders are typically derived from the install URL. This allows you specify the folder name used in your MODULAR_HOME pkg directory.

--install-version <INSTALL_VERSION>, -f

Installs a specified version instead of the latest available. Eg: 0.4.0.

--quiet, -q

Disable verbose output and the progress bar.

Common options

--help, -h

Displays help information.