chainkit-core
v0.1.3
Published
A toolkit for generating toolchains (Common generator API)
Downloads
11
Readme
chainkit - Toolchain Toolkit (Common generator API)
Chainkit is a toolkit for generating toolchains which can be integrated with various systems.
This package provides the common generator APIs, which are used by the various interface generators (e.g. chainkit-cli, chainkit-atom).
Why another task runner?
Chainkit is not another task runner. A task runner is designed to handle managing individual projects, and tasks are specified on a project-by-project basis. Chainkit generates toolchains - the toolchain specifies tasks which will be useful for a number of projects. Examples of toolchains might be:
- Docker CLI
- Heroku Toolbelt
- Meteor CLI
These toolchains give you common commands you will need to use for multiple projects. This is what chainkit is designed for.
How do I use it?
Note: This is the planned process. It is not all implemented quite yet.
# Install the core
$ npm install -g chainkit-core
# Create your toolchain project and cd to it:
$ chainkit new my-toolchain && cd $_
# Add your interfaces
$ npm install --save chainkit-cli chainkit-atom
# Edit your toolchain
$ edit index.js
# Do interface-specific stuff e.g. prepare distributions
$ chainkit build atom cli # same as `npm run build -- atom cli`