Compoze CLI

This package is under active development and is NOT ready for use.

The compoze cli is a tool designed to interact with the Compoze service from the command line. It aids in automating task, as well as deploying docker-compose projects to docker host. The purpose of this tool is not to provide source control functionality. It is to provide a way to bring local docker-compose projects to the Compoze service and ultimately to bring the Compoze service functionality to your docker host.

To Install

npm install compozecli -g

Supported Commands

• adduser

  • Register a new account on compoze.io

• login

  • login to an existing compoze account

• whoami

  • determine current authenticated user

• logout

  • destroy local auth file and log out of compoze

• init

  • initialize a remote namespace for a new project
  • creates a local compoze.json file for cli reference

• push

  • push a local docker-compose project up to compoze.io

• pull

  • pull a remote compoze project down (does not attempt to run the project)

• ls

  • list the remote projects you have and basic stats about each of them

• describe

  • display the short description of a given project

• rm

  • remove a remote project (password required)

• run

  • run a remote or local compoze project (requires docker and docker-compose to be installed)

• search

  • search the compoze service for projects

Benefits of Compoze and Compoze CLI

Compoze provides a simple way for you to store and retrieve your docker-compose projects. It is like the 'Docker Hub', but for docker-compose projects. We wanted a service that would allow people to share their docker-compose projects in a secure way, and provide some sane unanimity to the cluster fuck that we currently have.

The compoze cli tool is a great way to interact with the Compoze service, but lets be real, you can do that with a GUI from your browser via the web app. What is the real reason for having 'yet another cli tool'? We wanted a way to run our projects without the need of 'copy, paste, docker-compose up -d' that we normally had to do. With the cli tool, you can do compoze run <path/to/project> and it will connect to the compoze service, pull down the project, and run it for you. We felt that was a much better user experience than the previously mentioned method.

The final point to be made about the benefits of Compoze is analytics. We want to provide good analytics about your docker-compose projects so that you can see the power that Docker is bringing to your projects. Information is everything! Having the information, and having an easy way to consume the information will help you make better decisions about your projects.

These are the main benefits of Compoze. If we notice more, we'll update this list.