How to use the command 'pio package' (with examples)
The ‘pio package’ command is used to manage packages in the registry. It allows you to create, publish, and remove packages. Packages can only be removed within 72 hours from the date they are published.
Use case 1: Create a package tarball from the current directory
Code:
pio package pack --output path/to/package.tar.gz
Motivation: This use case allows you to create a package tarball from the current directory. This can be useful if you want to package your project for distribution or sharing.
Explanation: The ‘pio package pack’ command is used to create a package tarball. The ‘–output’ option is used to specify the output file path and name.
Example output:
Package created successfully at path/to/package.tar.gz
Use case 2: Create and publish a package tarball from the current directory
Code:
pio package publish
Motivation: This use case allows you to create and publish a package tarball from the current directory. This is useful if you want to share your package with others and make it available in the registry.
Explanation: The ‘pio package publish’ command is used to create and publish a package tarball. It automatically uploads the package to the registry.
Example output:
Package published successfully.
Use case 3: Publish the current directory and restrict public access to it
Code:
pio package publish --private
Motivation: This use case allows you to publish the current directory as a package and restrict public access to it. This can be useful if you want to share your package with only a select group of people.
Explanation: The ‘pio package publish’ command is used to publish a package. The ‘–private’ option is used to restrict public access to the package.
Example output:
Package published successfully. Access to the package restricted to authorized users.
Use case 4: Publish a package
Code:
pio package publish path/to/package.tar.gz
Motivation: This use case allows you to publish a package tarball from a specific file path. This is useful if you have already created a package tarball and want to publish it.
Explanation: The ‘pio package publish’ command is used to publish a package tarball. The file path to the package tarball is specified as an argument.
Example output:
Package published successfully.
Use case 5: Publish a package with a custom release date (UTC)
Code:
pio package publish path/to/package.tar.gz --released-at "2021-04-08 21:15:38"
Motivation: This use case allows you to publish a package tarball with a custom release date. This can be useful if you want to specify a specific date and time for the package release.
Explanation: The ‘pio package publish’ command is used to publish a package tarball. The ‘–released-at’ option is used to specify a custom release date and time in UTC format.
Example output:
Package published successfully with a custom release date of 2021-04-08 21:15:38.
Use case 6: Remove all versions of a published package from the registry
Code:
pio package unpublish package
Motivation: This use case allows you to remove all versions of a published package from the registry. This can be useful if you no longer want the package to be available for download.
Explanation: The ‘pio package unpublish’ command is used to remove a package from the registry. The package name is specified as an argument.
Example output:
All versions of the package 'package' have been removed from the registry.
Use case 7: Remove a specific version of a published package from the registry
Code:
pio package unpublish package@version
Motivation: This use case allows you to remove a specific version of a published package from the registry. This can be useful if you want to remove a specific version while keeping other versions available.
Explanation: The ‘pio package unpublish’ command is used to remove a package from the registry. The package name and version are specified as arguments.
Example output:
The version 'version' of the package 'package' has been removed from the registry.
Use case 8: Undo the removal, putting all versions or a specific version of the package back into the registry
Code:
pio package unpublish --undo package@version
Motivation: This use case allows you to undo the removal of a package from the registry. It restores all versions or a specific version of the package back into the registry.
Explanation: The ‘pio package unpublish’ command with the ‘–undo’ option is used to undo the removal of a package. The package name and version are specified as arguments.
Example output:
The version 'version' of the package 'package' has been restored to the registry.
Conclusion
The ‘pio package’ command provides a set of powerful options to create, publish, and manage packages in the registry. Whether you need to package your project, share it with others, or remove a package from the registry, the ‘pio package’ command has you covered.
