Package: cloudsmith-cli
Cloudsmith Command Line Interface (CLI)TheCloudsmithCommand Line Interface (CLI) is a Python 3 text-based interface to theAPI. This allows users, machines and other services to access and integrate smoothly with Cloudsmith without requiring explicit plugins or tools.Be awesome. Automate Everything.The following asciinema video demonstrates some of the CLI commands:We also have ademo video on YouTube:You can also read ourblog articlethat introduced the first version of the CLI and the Cloudsmith RESTful API.ChangelogPlease see thechangelogfor the list of changes by version. The current version is displayed in the PyPi badge at the top.FeaturesThe 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|depsList direct (non-transitive) dependencies for a package.distros:              List available distributions.entitlements|ents:  List entitlements for a repository.packages:             List packages for a repository. (Aliasesrepos 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.InstallationYou can install the latest CLI application from:Official CLI Repository @ PyPiOfficial CLI Repository @ CloudsmithThe simplest way is to usepip, such as:pip install --upgrade cloudsmith-cliOr 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/ConfigurationThere 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 calledcloudsmithin the OS-defined application directory. For example:Linux:$HOME/.config/cloudsmith$HOME/.cloudsmithMac OS:$HOME/Library/Application Support/cloudsmith$HOME/.cloudsmithWindows:C:\Users\<user>\AppData\Local\cloudsmith(Win7+, not roaming)C:\Users\<user>\AppData\Roaming\cloudsmith(Win7+, roaming)C:\Documents and Settings\<user>\Application Data\cloudsmith(WinXP, not roaming)C:\Documents and Settings\<user>\Local Settings\Application Data\cloudsmith(WinXP, roaming)C:\Documents and Settings\<user>\.cloudsmithBoth configuration files use the simple INI format, such as:[default]
api_key=1234567890abcdef1234567890abcdefNon-Credentials (config.ini)See thedefault configin 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 thedefault configin GitHub:You can specify the following configuration options:api_key: The API key for authenticating with the API.Getting Your API KeyYou'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 thecloudsmith logincommand: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: 1234567890abcdef1234567890abcdefOnce you have your API key you can then put this into yourcredentials.ini, use it as an environment variableexport CLOUDSMITH_API_KEY=your_key_hereor pass it to the CLI using the-k your_key_hereflag.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 PackagesAlthough 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 filenamelibxml2-2.9.4-2.x86_64.deb, representinglibxml 2.9.4, for theUbuntu 16.04distribution (which has a cloudsmith identifier ofubuntu/xenial):cloudsmith push deb your-account/your-repo/ubuntu/xenial libxml2-2.9.4-2.x86_64.debWant to know how to do it with another packaging format? Easy, just ask for help:cloudsmith push rpm --helpContributingYes! Please do contribute, this is why we love open source.  Please seeCONTRIBUTINGfor contribution guidelines when making code changes or raising issues for bug reports, ideas, discussions and/or questions (i.e. help required).LicenseCopyright 2018 Cloudsmith LtdLicensed 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.0Unless 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.EOFThis quality product was brought to you byCloudsmithand thefine folks who have contributed.