The pub tool
pub tool has commands for managing packages
and for deploying packages and command-line apps.
For general information about using the pub package manager, see
How to use packages.
Quick links to the
Pub’s commands fall into the following categories:
Managing package dependencies
Pub provides a number of commands for managing the packages your code depends on.
In this group, the most commonly used commands are
pub get and
pub upgrade, which retrieve or upgrade dependencies used by a package.
Every time you modify a pubspec file, run
to make sure the dependencies are up to date. Some IDEs
perform this step automatically on the creation of a project,
or any modification of the pubspec.
- Manages pub’s local package cache. Use this command to add packages to your cache, or to perform a clean reinstall of all packages in your cache.
- Lists all dependencies used by the current package.
- Retrieves the lowest versions of all the packages that are listed as dependencies used by the current package. Used for testing the lower range of your package’s dependencies.
- Retrieves the packages that are listed as the dependencies for
the current package.
pubspec.lockfile already exists, fetches the version of each dependency (if possible) as listed in the lock file. Creates or updates the lock file, as needed.
- Looks at every package that the current package depends on, determines which package dependencies are out of date, and gives you advice on how to update them. Use this command when you want to update package dependencies.
- Retrieves the latest version of each package listed
as dependencies used by the current package. If a
pubspec.lockfile exists, ignores the versions listed in the lock file and fetches the newest versions that honor the constraints in the pubspec. Creates or updates the lock file, as needed.
Running command-line apps
Two commands let you run Dart scripts from the command line:
pub runcommand invokes a Dart script in your package, or in one of its dependencies.
pub globalcommand lets you work with globally available packages.
Deploying packages and apps
With pub you can publish packages and command-line apps.
To share your Dart packages with the world, you can
pub publish command to upload the
package to the pub.dev site. The
pub uploader command enables specific
users to modify and upload new versions of your package.
For any package that contains scripts (anything under the
directory), consider adding the
executables tag to the pubspec file.
When a script is listed under
executables, users can run
pub global activate
to make it directly available from the command line.
Several command-line options work with all of the pub commands. These include:
- Print usage information.
- Print version of pub.
- Print debugging information when an error occurs.
- The specified level determines the amount of information that is displayed:
- Show all output, including internal tracing messages.
- Show I/O operations.
- Show errors, warnings, and user messages.
- Show steps during version resolution.
- Equivalent to