Adapt Command Line Interface
============================

[![Build Status](https://travis-ci.org/adaptlearning/adapt-cli.png?branch=master)](https://travis-ci.org/adaptlearning/adapt-cli)  [![Join the chat at https://gitter.im/adaptlearning/adapt-cli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/adaptlearning/adapt-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Installation
------------

To install the Adapt CLI, first be sure to install [NodeJS](http://nodejs.org) and [git](http://git-scm.com/downloads), then from the command line run:-
```
npm install -g adapt-cli
```

Usage
-----

##### Creating an Adapt course
```
adapt create {type} {path} [{branch}]
```
`type` What to create. The only types currently supported are `course` and `component`. If you want to create a new Adapt course, use `course`. If you want to develop a new Adapt component, use `component` to download a component template.
`path` The name of the directory you'd like the course to be downloaded to (relative to the current directory)  
`branch` (optional) The branch of the framework you'd like to use as the basis for your course. If your needs to support Internet Explorer v8, 9 or 10 then set this to `legacy`. If not, leave blank or set to `master`.

For example...
```
adapt create course "My Course"
```
This will download the Adapt framework and create an new course in the directory "My Course", in your current directory.

##### Searching for an Adapt plugin.
```
adapt search {name or partial name of plugin to search for}
```

##### Installing a plugin into your current directory
```
adapt install {name of plugin}
```
Additionally you can install a specific version of a plugin.
```
adapt install {name of plugin}#{version}
```
Anywhere that you are required to provide a name of a plugin it can be either fully qualified with 'adapt-' or optionally you can omit the prefix an just use the plugin name.

Therefore these commands are equivalent:
```
adapt install adapt-my-plugin
adapt install my-plugin
```
Installed plugins are saved to `adapt.json`.

##### Installing plugins previously saved in adapt.json
```
adapt install
```

##### Uninstalling a plugin from your current directory
```
adapt uninstall {name of plugin}
```

The Plugin Registry
-------------------

The plugin system is powered by [Bower](http://bower.io/). Each plugin should be a valid bower package and they should be registered with the Adapt registry.
```
http://adapt-bower-repository.herokuapp.com/packages/
```
See [Developing plugins](https://github.com/adaptlearning/adapt_framework/wiki/Developing-plugins) for more information on defining your plugins package.

##### Registering a plugin

From within a plugin directory
```
adapt register
```
`name` and `repository` will be read from `bower.json` in the current directory.

The package will be registered with the registry on a first come first serve basis.

##### Unregister a plugin

From within a plugin directory
```
adapt unregister
```
`name` will be read from `bower.json` in the current directory

Alternatively, from any directory
```
adapt unregister <plugin name>
```
You will be prompted to authenticate with GitHub.

The package will be unregistered with the registry if the authenticated user is a collaborator on the given endpoint or a collaborator on the Adapt framework.

##### Rename a plugin

From any directory
```
adapt rename <plugin name> <new plugin name>
```
You will be prompted to authenticate with GitHub.

The package will be renamed if the authenticated user is a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework.

Release History
===============
- 2.0.5 - Added rename and unregister commands and corrected some typos
- 2.0.4 - Corrected version numbers
- 2.0.3 - Fixed issue#53 - npm dependency is git url
- 2.0.2 - Fixed issue#32 - Error: Cannot find module 'Q' on case sensitive file systems
- 2.0.1 - Fixed an issue with installing dependencies (https://github.com/adaptlearning/adapt-cli/tree/hotfix/has-no-method-install)
- 2.0.0 - version bump to 2.0.0
- 0.0.24 - Pre v2.0.0 release update
- 0.0.23 - Updated NPM Module's version.
- 0.0.22 - Added the 'ls' command.
- 0.0.21 - Fixed an issue where the new slug library does not maintain case.
- 0.0.19 - Removed slug library due to annoying python dependency, added 'create component' command.
- 0.0.18 - Fixed Issue #23
- 0.0.17 - Added extra check current working directory for installing. See Issue #23
- 0.0.16 - Improved download progress bar; fixed dependency of the download package to a fork to avoid version conflict with decompress package. This should be temporary until the conflict is resolved.
- 0.0.15 - fixed Issue #22
- 0.0.14 - fixed Issue #15
- 0.0.13 - Added support for versions of plugins (#14) and --version command
- 0.0.12 - fixed Issue #13
- 0.0.11 - fixed Issue #12
- 0.0.10 - fixed Issue #2 & #8
- 0.0.9  - fixed Issue #7
- 0.0.8  - Added 'create' command, fixed Issue #6
- 0.0.7  - fixed Issue #3
- 0.0.6  - Added 'register' command
- 0.0.5  - Added adapt.json (dependency list)
- 0.0.3  - Added uninstall command
...