Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Registering a plugin
All plugins are Bower packages; to create your plugin you will first need to define your package, and then register it with our plugin registry.
Registering a new plugin
To register a plugin, it must first comply with the following:
- There must be a valid manifest
bower.jsonin the current working directory.
- Your package must be available at a Git endpoint (e.g.
- There must be a valid
.bowerrcfile in the current Git repository. See the adapt_framework repository for an example (you are fine to copy this as-is to your plugin source).
Once you are ready to publish, run the adapt command line interface and provide the required information.
$ adapt register
Your plugin will be published to the registry, you can confirm this by doing
adapt search <plugin-name>.
It is possible to maintain multiple versions of your plugin, giving you the freedom to change your plugin at any time without requiring existing users to migrate to newer versions. We strongly recommend that you follow Semantic version numbers for your releases.
To create a new version of a registered plugin, simply tag your git repository with the new version number.
To install a specific version of a plugin using the Adapt Command Line Interface run the install command followed by the name of the plugin, # symbol and then the version number.
For example, the following would install version
0.0.2 of the
adapt install hello-world#0.0.2
Note that if you don't create tags or releases, the Adapt CLI will always download the 'default branch' - usually 'master' - of your plugin.