Cloudsmith Documentation Hub

Welcome to the Cloudsmith Documentation Hub. You'll find comprehensive guides and documentation to help you start working with Cloudsmith as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Package Tags

Package tags allow you to add your own custom tags to your packages. You can then use tags to group and sort your packages via search queries (see Searching/Filtering for details), or to help you organize your packages in a way that suits you.

You can also use package tags in association with your entitlement tokens, in order to limit what packages your customers can access. For example, you can tag your packages and create an associated entitlement token in such a way that "standard edition" customers only have access to the "standard" packages, but "pro edition" customers have access to both "standard" and "pro" packages.

In addition, you can specify that tags you add are immutable. This means that they can only be modified or deleted by a user with repository admin privileges, or by the user that owns the package.

We provide three ways to manage your custom package tags:

  • via the Cloudsmith CLI
  • via the Cloudsmith API
  • via the Website UI

πŸ“˜

Some tags, such as filetype, architecture and other format-specific tags are generated automatically during package upload and processing, and therefore cannot be removed or modified.

Package Tags via the CLI

For full details of how to install and setup the Cloudsmith CLI, see Command-Line Interface.

To add or modify tags using the Cloudsmith CLI, you first need to identify the package you wish to tag or modify. See Package Identification for instructions to do this.

List Tags

The command to list all tags for a package is:

cloudsmith tags list OWNER/REPOSITORY/IDENTIFIER

Example:

cloudsmith tags list demo/examples-repo/ptqbzjgm2pq1

List tags

Add Tags

The command to add a tag to a package is:

cloudsmith tags add OWNER/REPOSITORY/IDENTIFIER TAG

You can add also add multiple tags:

cloudsmith tags add OWNER/REPOSITORY/IDENTIFIER TAG1,TAG2,TAG3

Example:

cloudsmith tags add demo/examples-repo/ptqbzjgm2pq1 foo,bar,baz

Add tag(s)

To add an immutable tag, use the --immutable flag.
Example:

cloudsmith tags add demo/examples-repo/ptqbzjgm2pq1 fizz --immutable

Add immutable tag(s)

You may also add tags when a package is uploaded via the cloudsmith push command.
Example:

cloudsmith push deb OWNER/REPOSITORY/DISTRO/VERSION PACKAGE-NAME.deb --tags TAG1, TAG2 

Replace Tags

The command to replace all tags (except immutable tags) on a package is:

cloudsmith tags replace OWNER/REPOSITORY/IDENTIFIER TAG

Example:

cloudsmith tags replace demo/examples-repo/ptqbzjgm2pq1 buzz

Replace tags

Remove Tags

The command to remove tags from a package is:

cloudsmith tags remove OWNER/REPOSITORY/IDENTIFIER TAG

πŸ“˜

You need to have repository admin privileges or be the package owner to remove immutable tags.

Example

cloudsmith tags remove demo/examples-repo/ptqbzjgm2pq1 baz

Remove Tag

Clear Tags

The command to clear all tags (except immutable tags) from a package is:

cloudsmith tags clear OWNER/REPOSITORY/IDENTIFIER

Example:

cloudsmith tags clear demo/examples-repo/ptqbzjgm2pq1

Clear tags

Package Tags via the API

You can add and modify tags via the Cloudsmith API.

Please see the full API Reference for details, including an interactive sandbox where you can test your API Calls.

Package Tags via the Website UI

To add or modify tags using the Website UI, click the blue "Edit package tags" button on a package details page:

Tags button

You are then presented with the "Edit Package Tags" form where you add, modify or remove tags:

Edit Package Tags Form

Updated 8 months ago


Package Tags


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


Cloudsmith: The new standard in Package Management and Software Distribution

With support for all major package formats, such as Docker. You can trust us to manage your package management for you.