Metadata-Version: 2.0
Name: cloudsmith-cli
Version: 0.1.0
Summary: Cloudsmith Command-Line Interface (CLI)
Home-page: https://github.com/cloudsmith-io/cloudsmith-cli
Author: Cloudsmith Ltd
Author-email: support@cloudsmith.io
License: Apache License 2.0
Description-Content-Type: UNKNOWN
Keywords: cloudsmith,cli,devops
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Dist: click (>=6.7)
Requires-Dist: click-configfile (>=0.2.3)
Requires-Dist: click-didyoumean (>=0.0.3)
Requires-Dist: click-spinner (>=0.1.7)
Requires-Dist: cloudsmith-api (==0.20.7)
Requires-Dist: colorama (>=0.3.9)
Requires-Dist: requests (>=2.18.4)
Requires-Dist: requests-toolbelt (>=0.8.0)
Requires-Dist: semver (>=2.7.9)
Requires-Dist: simplejson (>=3.12.0)
Requires-Dist: six (>=1.11.0)

Cloudsmith Command Line Interface (CLI)
=======================================

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.

Features
--------

The CLI currently supports the following commands:

-  ``check``: Check the status/version of the service.
-  ``delete``: Delete a package from a repository.
-  ``docs``: Launch the help website in your browser.
-  ``push``: Push/upload a new package to a repository.
-  ``status``: Get the synchronisation status for a package.
-  ``token``: Retrieve your API authentication token/key.
-  ``whoami``: Retrieve your current authentication status.

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``

   -  Windows: ``C:\Users\YourName\AppData\cloudsmith``

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

::

    # Default configuration
    [default]
    api_key='1234567890abcdef1234567890abcdef'

    # Profile-based configuration (not working yet)
    [profile:cloudsmith]
    api_key='fedcba0987654321fedcba0987654321'

Non-Credentials (config.ini)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

TODO

Credentials (credentials.ini)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can specify the following configuration options:

-  ``api_key``: To specify the authentication key/token for API access.

Examples
--------

TODO: Provide a list of examples for the CLI tool.

Contributing
------------

Yes! Please do contribute, this is why we love open source. Please see
``CONTRIBUTING.md`` for contribution guidelines when making code changes
or raising issues for bug reports, ideas, discussions and/or questions
(i.e. help required).

Releasing
---------

To make a new release for ``cloudsmith-cli`` follow the procedure for
virtualenv setup then:

::

    $ bumpversion <major|minor|revision>

A tag will automatically created along with the version bump commit.

EOF
---

This quality product was brought to you by
`Cloudsmith <https://cloudsmith.io>`__ and the fine folks mentioned in
``CONTRIBUTORS.md``.


