OVERVIEW: Perform operations on Swift packages.
SEE ALSO: swift build, swift run, swift test
(Run this command without --help to see possible dynamic plugin commands.)
USAGE: swift package <options> <subcommand>
PATHS & LOCATIONS:
--package-path <package-path>
Specify the package path to operate on (default current directory). This
changes the working directory before any other operation.
--cache-path <cache-path>
Specify the shared cache directory path.
--config-path <config-path>
Specify the shared configuration directory path.
--security-path <security-path>
Specify the shared security directory path.
--scratch-path <scratch-path>
Specify a custom scratch directory path. (default .build)
--swift-sdks-path <swift-sdks-path>
Path to the directory containing installed Swift SDKs.
--toolset <toolset> Specify a toolset JSON file to use when building for the target platform.
Use the option multiple times to specify more than one toolset. Toolsets
will be merged in the order they're specified into a single final toolset
for the current build.
--pkg-config-path <pkg-config-path>
Specify alternative path to search for pkg-config `.pc` files. Use the
option multiple times to
specify more than one path.
CACHING:
--enable-dependency-cache/--disable-dependency-cache
Determines whether dependency fetching uses a shared cache. (default:
--enable-dependency-cache)
--enable-build-manifest-caching/--disable-build-manifest-caching
(default: --enable-build-manifest-caching)
--manifest-cache <manifest-cache>
Caching mode of Package.swift manifests. Valid values are: (shared:
shared cache, local: package's build directory, none: disabled) (default:
shared)
--enable-experimental-prebuilts/--disable-experimental-prebuilts
Determines whether macros use prebuilt swift-syntax libraries. (default:
--enable-experimental-prebuilts)
LOGGING:
-v, --verbose Increase verbosity to include informational output.
--very-verbose, --vv Increase verbosity to include debug output.
-q, --quiet Decrease verbosity to only include error output.
--color-diagnostics/--no-color-diagnostics
Determines whether color diagnostics appear when printing to a TTY.
By default, the terminal enables color diagnostics when connected to a
TTY and disables them otherwise. (default: --no-color-diagnostics)
SECURITY:
--disable-sandbox Disable the sandbox when executing subprocesses.
--netrc Use netrc file even in cases where other credential stores are preferred.
--enable-netrc/--disable-netrc
Determines whether SwiftPM loads credentials from a netrc file. (default:
--enable-netrc)
--netrc-file <netrc-file>
Specify the netrc file path.
--resolver-fingerprint-checking <resolver-fingerprint-checking>
(default: strict)
--resolver-signing-entity-checking <resolver-signing-entity-checking>
(default: warn)
--enable-signature-validation/--disable-signature-validation
Determines whether SwiftPM validates signatures on package releases
downloaded from the registry. (default: --enable-signature-validation)
RESOLUTION:
--enable-prefetching/--disable-prefetching
(default: --enable-prefetching)
--force-resolved-versions, --disable-automatic-resolution, --only-use-versions-from-resolved-file
Only use versions from the Package.resolved file and fail resolution if
it is out-of-date.
--skip-update Skip updating dependencies from their remote during a resolution.
--disable-scm-to-registry-transformation
Disable source control to registry transformation. (default:
--disable-scm-to-registry-transformation)
--use-registry-identity-for-scm
Look up source control dependencies in the registry and use their
registry identity when possible to help deduplicate across the two
origins.
--replace-scm-with-registry
Look up source control dependencies in the registry and use the registry
to retrieve them instead of source control when possible.
--default-registry-url <default-registry-url>
Default registry URL to use, instead of the registries.json configuration
file.
BUILD OPTIONS:
-c, --configuration <configuration>
Build with the specified configuration. (values: debug, release)
-Xcc <Xcc> Pass flag through to all C compiler invocations.
-Xswiftc <Xswiftc> Pass flag through to all Swift compiler invocations.
-Xlinker <Xlinker> Pass flag through to all linker invocations.
-Xcxx <Xcxx> Pass flag through to all C++ compiler invocations.
--triple <triple>
--sdk <sdk>
--toolchain <toolchain>
--swift-sdk <swift-sdk> Filter for selecting a specific Swift SDK to build with.
--sanitize <sanitize> Turn on runtime checks for erroneous behavior. (values: address, thread,
undefined, scudo, fuzzer)
--auto-index-store/--enable-index-store/--disable-index-store
Determines whether to automatically index while building. (default:
--auto-index-store)
--enable-parseable-module-interfaces
-j, --jobs <jobs> The number of jobs to spawn in parallel during the build process.
(default: 64)
--use-integrated-swift-driver
--explicit-target-dependency-import-check <explicit-target-dependency-import-check>
Check that targets only import their explicitly declared dependencies.
(values: none, warn, error; default: none)
--build-system <build-system>
Specify the build system to use. (default: swiftbuild)
native - Native Build System (deprecated)
swiftbuild - Swift Build build engine (default)
xcode - Xcode build system integration (deprecated)
-debug-info-format <debug-info-format>
The Debug Information Format to use. (values: dwarf, codeview, none)
--experimental-enable-codesize-profile
Generate SIL, LLVM IR, and optimization record files for code size
profiling.
--experimental-codesize-profile-output-dir <experimental-codesize-profile-output-dir>
Directory to store code size profiling output files.
--enable-experimental-strip-products/--disable-experimental-strip-products
Whether or not to strip debug symbols from the final binary.
--enable-dead-strip/--disable-dead-strip
Determines whether the linker strips unused code. (default:
--enable-dead-strip)
--disable-local-rpath Disable adding $ORIGIN/@loader_path to the rpath by default.
TRAIT OPTIONS:
--traits <traits> Enable the specified traits of the package. Specify multiple traits as a
comma-separated list, for example: `--traits Trait1,Trait2`. When
enabling specific traits, you must also explicitly enable the default
traits by passing `defaults` to this option.
--enable-all-traits Enable all traits of the package.
--disable-default-traits
Disable all default traits of the package.
OPTIONS:
--version Show the version.
SUBCOMMANDS:
add-dependency Add a package dependency to the manifest.
add-product Add a new product to the manifest.
add-target Add a new target to the manifest.
add-target-dependency Add a new target dependency to the manifest.
add-setting Add a new setting to the manifest.
experimental-audit-binary-artifact
Audit a static library binary artifact for undefined symbols.
add-target-plugin Add a new target plugin to the manifest
clean Delete build artifacts.
purge-cache Purge the global repository cache.
reset Reset the complete cache/build directory.
update Update package dependencies.
describe Describe the current package.
init Initialize a new package.
migrate Migrate a package or its individual targets to use the given set of
features.
experimental-install Offers the ability to install executable products of the current package.
experimental-uninstall Offers the ability to uninstall executable products previously installed
by `swift package experimental-install`.
diagnose-api-breaking-changes
Diagnose API-breaking changes to Swift modules in a package.
dump-symbol-graph Dump symbol graphs.
dump-package Print parsed Package.swift as JSON.
edit Put a package in editable mode.
unedit Remove a package from editable mode.
config Manipulate configuration of the package
resolve Resolve package dependencies.
generate-sbom Generate a Software Bill of Materials (SBOM).
show-dependencies Print the resolved dependency graph.
show-executables List the available executables from this package.
show-traits List the available traits for a package.
tools-version Manipulate tools version of the current package.
compute-checksum Compute the checksum for a binary artifact.
archive-source Create a source archive for the package.
completion-tool Command to generate shell completions.
plugin Invoke a command plugin or perform other actions on command plugins.
See 'swift help package <subcommand>' for detailed help.
Options (45)
| Option | Description | Source |
|---|---|---|
--package-path package-path | Specify the package path to operate on (default current directory). | help |
--cache-path cache-path | Specify the shared cache directory path. | help |
--config-path config-path | Specify the shared configuration directory path. | help |
--security-path security-path | Specify the shared security directory path. | help |
--scratch-path scratch-path | Specify a custom scratch directory path. | help |
--swift-sdks-path swift-sdks-path | Path to the directory containing installed Swift SDKs. | help |
--toolset toolset | Specify a toolset JSON file to use when building for the target platform. | help |
--pkg-config-path pkg-config-path | Specify alternative path to search for pkg-config `.pc` files. | help |
--manifest-cache manifest-cache | Caching mode of Package.swift manifests. | help |
-v, --verbose | Increase verbosity to include informational output. | help |
--very-verbose, --vv | Increase verbosity to include debug output. | help |
-q, --quiet | Decrease verbosity to only include error output. | help |
--disable-sandbox | Disable the sandbox when executing subprocesses. | help |
--netrc | Use netrc file even in cases where other credential stores are preferred. | help |
--netrc-file netrc-file | Specify the netrc file path. | help |
--resolver-fingerprint-checking resolver-fingerprint-checking | (default: strict) | help |
--resolver-signing-entity-checking resolver-signing-entity-checking | (default: warn) | help |
--force-resolved-versions, --disable-automatic-resolution, --only-use-versions-from-resolved-file | Only use versions from the Package.resolved file and fail resolution if it is out-of-date. | help |
--skip-update | Skip updating dependencies from their remote during a resolution. | help |
--disable-scm-to-registry-transformation | Disable source control to registry transformation. | help |
--use-registry-identity-for-scm | Look up source control dependencies in the registry and use their registry identity when possible to help deduplicate across the two origins. | help |
--replace-scm-with-registry | Look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible. | help |
--default-registry-url default-registry-url | Default registry URL to use, instead of the registries.json configuration file. | help |
-c, --configuration configuration | Build with the specified configuration. | help |
-Xcc Xcc | Pass flag through to all C compiler invocations. | help |
-Xswiftc Xswiftc | Pass flag through to all Swift compiler invocations. | help |
-Xlinker Xlinker | Pass flag through to all linker invocations. | help |
-Xcxx Xcxx | Pass flag through to all C++ compiler invocations. | help |
--triple triple | help | |
--sdk sdk | help | |
--toolchain toolchain | help | |
--sanitize sanitize | Turn on runtime checks for erroneous behavior. | help |
--enable-parseable-module-interfaces | help | |
-j, --jobs jobs | The number of jobs to spawn in parallel during the build process. | help |
--use-integrated-swift-driver | help | |
--explicit-target-dependency-import-check explicit-target-dependency-import-check | Check that targets only import their explicitly declared dependencies. | help |
--build-system build-system | Specify the build system to use. | help |
-debug-info-format debug-info-format | The Debug Information Format to use. | help |
--experimental-enable-codesize-profile | Generate SIL, LLVM IR, and optimization record files for code size profiling. | help |
--experimental-codesize-profile-output-dir experimental-codesize-profile-output-dir | Directory to store code size profiling output files. | help |
--disable-local-rpath | Disable adding $ORIGIN/@loader_path to the rpath by default. | help |
--traits traits | Enable the specified traits of the package. | help |
--enable-all-traits | Enable all traits of the package. | help |
--disable-default-traits | Disable all default traits of the package. | help |
--version | Show the version. | help |