-
Notifications
You must be signed in to change notification settings - Fork 246
Adapt Command Line Interface
Important: the CLI is only for use with developing standalone courses using the framework. Please do not attempt to use it in conjunction with an authoring tool installation.
The Adapt command-line interface (CLI) is a set of cross platform command-line tools for developers to create, manage and build Adapt courses and plugin.
Check out the CLI's README for full details.
Prerequisites: NodeJS (and NPM)
To install the Adapt CLI, run the following from the command line:
$ npm install adapt-cli -g
This will install the CLI globally (i.e. allow you to access the tools from anywhere on your computer).
To update the Adapt CLI run the following command
$ npm update adapt-cli -g
- Create courses
- Search for plugins
- Install a plugin
- Uninstall a plugin
adapt create {type} {path} [{branch}]
type - What to create. Only the value "course" is currently supported. path - The directory of the new course. branch - Optional - The branch of the framework to be downlaoded.
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.
adapt search {name or partial name of plugin to search for}
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
.
adapt install
adapt uninstall {name of plugin}
The plugin system is powered by Bower. 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 for more information on defining your plugins package.
From within a plugin directory
adapt register
name
and repository
will be read from bower.json
in the current directory.
- Framework in Five Minutes
- Setting up Your Development Environment
- Manual Installation of the Adapt Framework
- Adapt Command Line Interface
- Common Issues
- Reporting Bugs
- Requesting Features
- Creating Your First Course
- Styling Your Course
- Configuring Your Project with config.json
- Content starts with course.json
- Course Localisation
- Compiling, testing and deploying your Adapt course
- Core Plugins in the Adapt Learning Framework
- Converting a Course from Framework Version 1 to Version 2
- Contributing to the Adapt Project
- Git Flow
- Adapt API
- Adapt Command Line Interface
- Core Events
- Core Model Attributes
- Core Modules
- Web Security Audit
- Peer Code Review
- Plugins
- Developing Plugins
- Developer's Guide: Components
- Developer's Guide: Theme
- Making a theme editable
- Developer's Guide: Menu
- Registering a Plugin
- Semantic Version Numbers
- Core Model Attributes
- Adapt Command Line Interface
- Accessibility v3
- Adapt Framework Right to Left (RTL) Support