Documentation
Open Cloudsmith

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 Cloudsmith web app

Note

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:

shell
cloudsmith tags list OWNER/REPOSITORY/IDENTIFIER

Example:

shell
cloudsmith tags list demo/examples-repo/ptqbzjgm2pq1
List tags

Add Tags

The command to add a tag to a package is:

shell
cloudsmith tags add OWNER/REPOSITORY/IDENTIFIER TAG

You can add also add multiple tags:

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

Example:

shell
cloudsmith tags add demo/examples-repo/ptqbzjgm2pq1 foo,bar,baz
Add tag(s)

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

shell
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:

shell
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:

shell
cloudsmith tags replace OWNER/REPOSITORY/IDENTIFIER TAG

Example:

shell
cloudsmith tags replace demo/examples-repo/ptqbzjgm2pq1 buzz
Replace tags

Remove Tags

The command to remove tags from a package is:

shell
cloudsmith tags remove OWNER/REPOSITORY/IDENTIFIER TAG

Note

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

Example

shell
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:

shell
cloudsmith tags clear OWNER/REPOSITORY/IDENTIFIER

Example:

shell
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 more details.

Package Tags via the Cloudsmith web app

To add or modify tags using the Cloudsmith web app, click on the package name first, then click on the blue plus sign within the "Tags" section within the package information:


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