Skip to content
This repository has been archived by the owner on Apr 9, 2018. It is now read-only.
Joseph Silvestre edited this page Jun 26, 2013 · 7 revisions

Cozy Manager is a CLI tool for Cozy Web Application developers. It makes starting building an application for the Cozy Cloud Platform easy.

It requires a github account for a full usage.

Installation

npm install -g cozy

Help

cozy --help

Managing Cozy Application projects

You can create and deploy your application easily.

Create a project

cozy new <appname> --github <yourgithubaccount> --url <yourcozycloudurl>
cd <appname>

This will create a folder with an application skeleton and a deploy_config.coffee file. The arguments are not mandatory, still they are required to deploy your app on your CozyCloud.

Deploy a project

cd <appname>
cozy deploy

This command use the deploy_config.coffee file in the root of the project folder.

Managing your virtual machine

CozyManager has commands to make using a virtual machine easy. Please refer to our setup guide to know why using a virtual machine could be a good idea.

Basically, we wrap Vagrant commands inside the CozyManager.

Initializing the development environment

cozy dev:init

This command will download the base box (if it's not already on your local system) and initialize the current directory in order to start your virtual machine.

Starting / Stopping the virtual machine

cozy dev:start
cozy dev:stop

Nothing magic here. This will start and stop your virtual machine. You can use the cozy dev:stop --halt to properly stop the VM. Otherwise it will be suspended (faster recovery but more disk space usage).

Checking if the virtual machine is working properly

cozy dev:vm-status

This will tell you which services are running and accessible and which are not. If everything is "ok", you are ready to start working on your awesome app!

Updating cozy core services

cozy dev:light-update

The core services are improved and you might feel you need to be up to date.

Removing the virtual machine from your machine

cozy dev:destroy

We might do major upgrades of the cozy core services and publish a new base box. This is how you should remove your current VM to add a new one with cozy dev:init. Be careful here! You will lose all your data!