Package Search Help

You can use boolean logic (e.g. AND/OR/NOT) for complex search queries. For more help and examples, see the search documentation.

Search by package name:
my-package (implicit)
name:my-package (explicit)

Search by package filename:
my-package.ext (implicit)
filename:my-package.ext (explicit)

Search by package tag:
latest (implicit)
tag:latest (explicit)

Search by package version:
1.0.0 (implicit)
version:1.0.0 (explicit)
prerelease:true (prereleases)
prerelease:false (no prereleases)

Search by package architecture:
architecture:x86_64 

Search by package distribution:
distribution:el 

Search by package license:
license:MIT 

Search by package format:
format:deb 

Search by package status:
status:in_progress 

Search by package file checksum:
checksum:5afba 

Search by package security status:
severity:critical 

Search by package vulnerabilities:
vulnerabilities:>1 
vulnerabilities:<1000 

Search by # of package downloads:
downloads:>8 
downloads:<100 

Search by package type:
type:binary 
type:source 

Search by package size (bytes):
size:>50000 
size:<10000 

Search by dependency name/version:
dependency:log4j 
dependency:log4j=1.0.0 
dependency:log4j>1.0.0 

Search by uploaded date:
uploaded:>"1 day ago" 
uploaded:<"August 14, 2022 EST" 

Search by entitlement token (identifier):
entitlement:3lKPVJPosCsY 

Search by policy violation:
policy_violated:true
license_policy_violated:true
vulnerability_policy_violated:true

Search by repository:
repository:repo-name

Search queries for all Maven-specific (and related) package types

Search by group ID:
maven_group_id:org.apache 

Field type modifiers (depending on the type, you can influence behaviour)

For all queries, you can use:
~foo for negation

For string queries, you can use:
^foo to anchor to start of term
foo$ to anchor to end of term
foo*bar for fuzzy matching

For number/date or version queries, you can use:
>foo for values greater than
>=foo for values greater / equal
<foo for values less than
<=foo for values less / equal

Need a secure and centralised artifact repository to deliver Alpine, Cargo, CocoaPods, Composer, Conan, Conda, CRAN, Dart, Debian, Docker, Go, Helm, Hex, LuaRocks, Maven, npm, NuGet, P2, Python, RedHat, Ruby, Swift, Terraform, Vagrant, Raw & More packages?

Cloudsmith is the new standard in Package / Artifact Management and Software Distribution.

With support for all major package formats, you can trust us to manage your software supply chain.

Start My Free Trial
 Open-Source cloudsmith cloudsmith (Cloudsmith) / cli  GitHub Project
Official repository for the Cloudsmith CLI application.
These tend to be pre-releases, for stable releases download from PyPi: https://pypi.python.org/pypi/cloudsmith-cli
Note: Packages in this repository are licensed as Apache License 2.0 (dependencies may be licensed differently).

Python logo cloudsmith-cli  0.35.0

One-liner (summary)

Cloudsmith Command-Line Interface (CLI)

Description

# Cloudsmith Command Line Interface (CLI)

[![Latest Version @ Cloudsmith](https://api-prd.cloudsmith.io/badges/version/cloudsmith/cli/python/cloudsmith-cli/latest/xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true)](https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/latest/xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/) [![Python Versions](https://img.shields.io/pypi/pyversions/cloudsmith-cli.svg)](https://pypi.python.org/pypi/cloudsmith-cli) [![PyPI Version](https://img.shields.io/pypi/v/cloudsmith-cli.svg)](https://pypi.python.org/pypi/cloudsmith-cli) [![CircleCI](https://circleci.com/gh/cloudsmith-io/cloudsmith-cli.svg?style=svg)](https://circleci.com/gh/cloudsmith-io/cloudsmith-cli) [![Maintainability](https://api.codeclimate.com/v1/badges/c4ce2988b461d7b31cd5/maintainability)](https://codeclimate.com/github/cloudsmith-io/cloudsmith-cli/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c4ce2988b461d7b31cd5/test_coverage)](https://codeclimate.com/github/cloudsmith-io/cloudsmith-cli/test_coverage) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

The [Cloudsmith](https://cloudsmith.io) Command Line Interface (CLI) is a Py2/Py3 text-based interface to the [API](https://api.cloudsmith.io). This allows users, machines and other services to access and integrate smoothly with Cloudsmith without requiring explicit plugins or tools. [Be awesome. Automate Everything](https://cloudsmith.com/company/the-tao-of-cloudsmith/).

The following asciinema video demonstrates some of the CLI commands: [![asciicast](https://asciinema.org/a/DkNXQWQGBjWkfGPAkDAPNz7xe.svg)](https://asciinema.org/a/DkNXQWQGBjWkfGPAkDAPNz7xe)

We also have a [demo video on YouTube](https://youtu.be/R-g8ZhDwTKk):

You can also read our [blog article](https://blog.cloudsmith.io/2017/11/25/automation-as-simple-as-a-b-cli/) that introduced the first version of the CLI and the Cloudsmith RESTful API.

## Changelog

Please see the [changelog](https://github.com/cloudsmith-io/cloudsmith-cli/blob/master/CHANGELOG.md) for the list of changes by version. The current version is displayed in the PyPi badge at the top.

## Features

The CLI currently supports the following commands (and sub-commands):

  • check: Check rate limits and service status.
  • copy`|`cp: Copy a package to another repository.
  • delete`|`rm: Delete a package from a repository.
  • dependencies`|`deps: List direct (non-transitive) dependencies for a package.
  • docs: Launch the help website in your browser.
  • entitlements`|`ents: Manage the entitlements for a repository. - create`|`new: Create a new entitlement in a repository. - delete`|`rm: Delete an entitlement from a repository. - list`|`ls: List entitlements for a repository. - refresh: Refresh an entitlement in a repository. - sync: Sync entitlements from another repository. - update`|`set: Update (patch) a entitlement in a repository.
  • help: Display the delightful help message and exit.
  • list`|`ls: List distros, packages, repos and entitlements. - dependencies`|`deps List direct (non-transitive) dependencies for a package. - distros: List available distributions. - entitlements`|`ents: List entitlements for a repository. - packages: List packages for a repository. (Aliases repos list) - repos: List repositories for a namespace (owner).
  • login`|`token: Retrieve your API authentication token/key via login.
  • metrics: Metrics and statistics for a repository. - tokens: Retrieve bandwidth usage for entitlement tokens. - packages: Retrieve package usage for repository.
  • move`|`mv: Move (promote) a package to another repo.
  • push`|`upload: Push (upload) a new package to a repository. - alpine: Push (upload) a new Alpine package upstream. - cargo: Push (upload) a new Cargo package upstream. - composer: Push (upload) a new Composer package upstream. - cocoapods: Push (upload) a new CocoaPods package upstream. - conan: Push (upload) a new Conan (C++) package upstream. - cran: Push (upload) a new R/CRAN package upstream. - deb: Push (upload) a new Debian package upstream. - docker: Push (upload) a new Docker image upstream. - go: Push (upload) a new Go module upstream. - helm: Push (upload) a new Helm package upstream. - luarocks: Push (upload) a new Lua module upstream. - maven: Push (upload) a new Maven package upstream. - npm: Push (upload) a new Npm package upstream. - nuget: Push (upload) a new NuGet package upstream. - python: Push (upload) a new Python package upstream. - raw: Push (upload) a new Raw package upstream. - rpm: Push (upload) a new RedHat package upstream. - ruby: Push (upload) a new Ruby package upstream. - terraform: Push (upload) a new Terraform package upstream. - vagrant: Push (upload) a new Vagrant package upstream.
  • quarantine`|`block: Manage quarantined packages in a repository. - add: Add a package to quarantine. - remove`|`rm`|`restore: Add a package to quarantine.
  • quota: Quota limits and history for a organisation. - limits: Display the Quota (bandwidth & storage usage/limits) for a specific organisation. - history: Display the Quota History (upload, download, and storage usage/limits) for a specific organisation.
  • repositories`|`repos: Manage repositories. - create`|`new: Create a new repository in a namespace. - get`|`list`|`ls: List repositories for a user, in a namespace or get details for a specific repository. - update: Update a repository in a namespace. - delete`|`rm: Delete a repository from a namespace.
  • resync: Resynchronise a package in a repository.
  • status: Get the synchronisation status for a package.
  • tags: Manage the tags for a package in a repository. - add: Add tags to a package in a repository. - clear: Clear all existing (non-immutable) tags from a package in a repository. - list`|`ls: List tags for a package in a repository. - remove`|`rm: Remove tags from a package in a repository. - replace: Replace all existing (non-immutable) tags on a package in a repository.
  • whoami: Retrieve your current authentication status.

## Installation

You can install the latest CLI application from:

The simplest way is to use pip, such as:

` pip install --upgrade cloudsmith-cli `

Or you can get the latest pre-release version from Cloudsmith:

` pip install --upgrade cloudsmith-cli --extra-index-url=https://dl.cloudsmith.io/public/cloudsmith/cli/python/index/ `

## Configuration

There are two configuration files used by the CLI:

  • config.ini: For non-credentials configuration.
  • credentials.ini: For credentials (authentication) configuration.

By default, the CLI will look for these in the following locations:

  • The current working directory.

  • A directory called cloudsmith in the OS-defined application directory. For example: - Linux:

    • $HOME/.config/cloudsmith
    • $HOME/.cloudsmith
    • Mac OS: - $HOME/Library/Application Support/cloudsmith - $HOME/.cloudsmith
    • Windows: - C:Users<user>AppDataLocalcloudsmith (Win7+, not roaming) - C:Users<user>AppDataRoamingcloudsmith (Win7+, roaming) - C:Documents and Settings<user>Application Datacloudsmith (WinXP, not roaming) - C:Documents and Settings<user>Local SettingsApplication Datacloudsmith (WinXP, roaming)

Both configuration files use the simple INI format, such as:

` [default] api_key=1234567890abcdef1234567890abcdef `

### Non-Credentials (config.ini)

See the [default config](https://raw.githubusercontent.com/cloudsmith-io/cloudsmith-cli/master/cloudsmith_cli/data/config.ini) in GitHub:

You can specify the following configuration options:

  • api_host: The API host to connect to.
  • api_proxy: The API proxy to connect through.
  • api_ssl_verify: Whether or not to use SSL verification for requests.
  • api_user_agent: The user agent to use for requests.

### Credentials (credentials.ini)

See the [default config](https://raw.githubusercontent.com/cloudsmith-io/cloudsmith-cli/master/cloudsmith_cli/data/credentials.ini) in GitHub:

You can specify the following configuration options:

  • api_key: The API key for authenticating with the API.

### Getting Your API Key

You'll need to provide authentication to Cloudsmith for any CLI actions that result in accessing private data or making changes to resources (such as pushing a new package to a repository)..

With the CLI this is simple to do. You can retrieve your API key using the cloudsmith login command:

` cloudsmith login Login: you@example.com Password: Repeat for confirmation: `

Note: Please ensure you use your email for the 'Login' prompt and not your user slug/identifier.

The resulting output looks something like:

` Retrieving API token for 'you@example.com' ... OK Your API token is: 1234567890abcdef1234567890abcdef `

Once you have your API key you can then put this into your credentials.ini, use it as an environment variable export CLOUDSMITH_API_KEY=your_key_here or pass it to the CLI using the -k your_key_here flag.

For convenience the CLI will ask you if you want to install the default configuration files, complete with your API key, if they don't already exist. Say 'y' or 'yes' to create the configuration files.

If the configuration files already exist, you'll have to manually put the API key into the configuration files, but the CLI will print out their locations.

## Uploading Packages

Although native uploads, i.e. those supported by the native ecosystem of a package format, are often preferred; it's easy to publish with the Cloudsmith CLI too!

For example, if you wanted to upload a Debian package, you can do it in one-step. Assuming you have a package filename libxml2-2.9.4-2.x86_64.deb, representing libxml 2.9.4, for the Ubuntu 16.04 distribution (which has a cloudsmith identifier of ubuntu/xenial):

` cloudsmith push deb your-account/your-repo/ubuntu/xenial libxml2-2.9.4-2.x86_64.deb `

Want to know how to do it with another packaging format? Easy, just ask for help:

` cloudsmith push rpm --help `

## Contributing

Yes! Please do contribute, this is why we love open source. Please see [CONTRIBUTING](https://github.com/cloudsmith-io/cloudsmith-cli/blob/master/CONTRIBUTING.md) for contribution guidelines when making code changes or raising issues for bug reports, ideas, discussions and/or questions (i.e. help required).

## License

Copyright 2018 Cloudsmith Ltd

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

## EOF

This quality product was brought to you by [Cloudsmith](https://cloudsmith.io) and the [fine folks who have contributed](https://github.com/cloudsmith-io/cloudsmit

Size

83.2 KB

Downloads

2

Tags

bdist/wheel whl noarch py2/py3

Status  Completed
Checksum (MD5) d1a215fb83622ea45a27f47e1ecbd641
Checksum (SHA-1) 8409afc13a6c7d3a6fb56c747af3ce27cf2127a3
Checksum (SHA-256) 607e274cf132e7f8c58bfe6e02cbaaf91f60d24233ab7d4157eae1613dc10e36
Checksum (SHA-512) 45f505ca46086cc666271091d0cfce846412f961a6f641218074591f7cfc2174a7…
GPG Signature
Storage Region Default Region
Type  Binary (contains binaries and binary artifacts)
Uploaded At 5 months, 2 weeks ago
Uploaded By Uploaded by CLI Publisher
Slug Id cloudsmith_cli-0350-py2py3-none-anywhl-1Xt
Unique Id aKXn77JLAulJ
Version (Raw) 0.35.0
Version (Parsed)
  • Major: 0
  • Minor: 35
  • Patch: 0
  • Type: SemVer (Strict)
  extended metadata
Author Cloudsmith Ltd <support@cloudsmith.io>
Classifiers Development Status :: 5 - Production/Stable | Environment :: Console | Intended Audience :: Developers | Intended Audience :: System Administrators | License :: OSI Approved :: Apache Software License | Operating System :: POSIX :: Linux | Programming Language :: Python | Programming Language :: Python :: 2 | Programming Language :: Python :: 3 | Topic :: Internet | Topic :: System :: Systems Administration | Topic :: Utilities
Homepage URL https://github.com/cloudsmith-io/cloudsmith-cli
Keywords cloudsmith,cli,devops
Metadata Version 2.1
Platforms any
Py Filetype bdist_wheel
Py Version py2.py3
Requires Dist click (!=8.0.2,>=7.0) | click-configfile (>=0.2.3) | click-didyoumean (>=0.0.3) | click-spinner (>=0.1.7) | cloudsmith-api (<3.0,>=2.0.0) | colorama (>=0.3.9) | future (>=0.16.0) | requests (>=2.18.4) | requests-toolbelt (>=0.8.0) | semver (>=2.7.9) | simplejson (>=3.12.0) | six (>=1.11.0)
pkg cloudsmith_cli-0.35.0-py2.py3-n… 2
83.2 KB
md5 sha1 sha256 sha512
Package Contents (cloudsmith_cli-0.35.0-py2.py3-none-any.whl)
Loading...

This package has 80 files/directories.

 Newer Python logo
cloudsmith-cli
 0.39.0
bdist/wheel whl noarch py2/py3
0 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.38.1
bdist/wheel whl noarch py2/py3
0 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.38.0
bdist/wheel whl noarch py2/py3
0 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.37.2
bdist/wheel whl noarch py2/py3
83.4 KB 1 month ago
1 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.37.1
bdist/wheel whl noarch py2/py3
83.4 KB 1 month ago
0 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.37.0
bdist/wheel whl noarch py2/py3
7 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.36.1
bdist/wheel whl noarch py2/py3
7 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.36.0
bdist/wheel whl noarch py2/py3
1 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.35.2
bdist/wheel whl noarch py2/py3
12 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.35.1
bdist/wheel whl noarch py2/py3
2 Uploaded by CLI Publisher
  Python logo
cloudsmith-cli
 0.35.0
bdist/wheel whl noarch py2/py3
2 Uploaded by CLI Publisher
 Newer Python logo
cloudsmith-cli
 0.42.0
bdist/wheel whl noarch py2/py3 latest
3 Uploaded by CLI Publisher
 Older Python logo
cloudsmith-cli
 0.34.0
bdist/wheel whl noarch py2/py3
22 aspeed
 Older Python logo
cloudsmith-cli
 0.33.0
bdist/wheel whl noarch py2/py3
83.0 KB 1 year ago
36 aspeed
 Older Python logo
cloudsmith-cli
 0.32.0
bdist/wheel whl noarch py2/py3
46 aspeed
 Older Python logo
cloudsmith-cli
 0.31.1
bdist/wheel whl noarch py2/py3
26 aspeed
 Older Python logo
cloudsmith-cli
 0.31.0
bdist/wheel whl noarch py2/py3
27 aspeed
 Older Python logo
cloudsmith-cli
 0.30.2
bdist/wheel whl noarch py2/py3
23 aspeed
 Older Python logo
cloudsmith-cli
 0.30.1
bdist/wheel whl noarch py2/py3
24 aspeed
 Older Python logo
cloudsmith-cli
 0.30.0
bdist/wheel whl noarch py2/py3
26 aspeed

Last scanned

5 months, 2 weeks ago

Scan result

Clean

Vulnerability count

0

Max. severity

Unknown
Loading...

You can embed a badge in another website that shows this or the latest version of this package.

To embed the badge for this specific package version, use the following:

[![This version of 'cloudsmith-cli' @ Cloudsmith](https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true)](https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/)
|This version of 'cloudsmith-cli' @ Cloudsmith|
.. |This version of 'cloudsmith-cli' @ Cloudsmith| image:: https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true
   :target: https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/
image::https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true[link="https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/",title="This version of 'cloudsmith-cli' @ Cloudsmith"]
<a href="https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/0.35.0/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true" alt="This version of 'cloudsmith-cli' @ Cloudsmith" /></a>

rendered as: This version of 'cloudsmith-cli' @ Cloudsmith

To embed the badge for the latest package version, use the following:

[![Latest version of 'cloudsmith-cli' @ Cloudsmith](https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true&show_latest=true)](https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/)
|Latest version of 'cloudsmith-cli' @ Cloudsmith|
.. |Latest version of 'cloudsmith-cli' @ Cloudsmith| image:: https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true&show_latest=true
   :target: https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/
image::https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true&show_latest=true[link="https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/",title="Latest version of 'cloudsmith-cli' @ Cloudsmith"]
<a href="https://cloudsmith.io/~cloudsmith/repos/cli/packages/detail/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/cloudsmith/cli/python/cloudsmith-cli/latest/a=noarch;xf=bdist_wheel;xn=cloudsmith-cli;xv=py2.py3/?render=true&show_latest=true" alt="Latest version of 'cloudsmith-cli' @ Cloudsmith" /></a>

rendered as: Latest version of 'cloudsmith-cli' @ Cloudsmith

These instructions assume you have setup the repository first (or read it).

To install/use cloudsmith-cli @ version 0.35.0 ...

pip install 'cloudsmith-cli==0.35.0'

You can also install the latest version of this package:

pip install --upgrade 'cloudsmith-cli'

If necessary, you can specify the repository directly:

pip install \
  --index-url=https://dl.cloudsmith.io/public/cloudsmith/cli/python/simple/ \
  cloudsmith-cli==0.35.0

If you've got a project requirements.txt file, you can specify this as a dependency:

--index-url=https://dl.cloudsmith.io/public/cloudsmith/cli/python/simple/
cloudsmith-cli==0.35.0

In addition, you can use this repository as an extra index url. However, please read our documentation on this parameter before using it. For example in a requirements.txt file:

--extra-index-url=https://dl.cloudsmith.io/public/cloudsmith/cli/python/simple/
cloudsmith-cli==0.35.0
Warning: We highly recommend using pip (or similar) rather than installing directly.
Top