[![npm version][npm-img]][npm] ![downloads][dl-img]

Interact with Cloudpath from the comfort of your CLI.

See the CLI command line reference to get started.

Table of Contents

Click to expand

• Installation
• Usage
• Documentation
• Commands
  • cdn
  • hosting
  • login
  • release
• Contributing
• Development
• License

Installation

Cloudpath CLI requires Node.js version 14 or above. To install, run the following command from any directory in your terminal:

npm install @cloudpath/cli -g

When using the CLI in a CI environment we recommend installing it locally as a development dependency, instead of globally. To install locally, run the following command from the root directory of your project:

npm install --save-dev @cloudpath/cli

Usage

Installing the CLI globally provides access to the cloudpath command.

cloudpath [command]

# Run `help` for detailed information about CLI commands
cloudpath [command] help

Documentation

To learn how to log in to Cloudpath and start deploying sites, visit the documentation on Cloudpath.

Commands

cdn

Various content delivery commands.

Subcommand	description
cdn:buckets:create	Create a new bucket
cdn:buckets:list	List existing buckets.
cdn:upload	Upload a single or multiple of files to a bucket directory.

hosting

Various website hosting commands.

Subcommand	description
hosting:deploy	Create a new deploy from the contents of a folder.
hosting:sites:create	Create a new site.
hosting:sites:list	List your existing sites
hosting:sites:delete	Delete a site.
hosting:sites:releases:list	List a site's releases.
hosting:sites:releases:create	Create a site release by distribution group or release track (ex: stable, beta, etc)

login

Login to your Cloudpath account

release

Handle various site operations

Subcommand	description
release:applications:list	List existing release applications.
release:applications:distribution-groups	(Beta) Create a site from a starter template
release:applications:distribution-groups	Delete a site

Contributing

See CONTRIBUTING.md for more info on how to make contributions to this project.

Development

You'll need to follow these steps to run Cloudpath CLI locally:

uninstall any globally installed versions of @cloudpath/cli
clone and install deps for https://github.com/cloudpath-software/cli
npm link from inside the cli folder

Now you're both ready to start testing and to contribute to the project!

License

MIT. See LICENSE for more details.