Konstruct Cli

The Konstruct Cli provides tools to make working with Konstruct painless and quick. You can access documentation, build a new project structure and scaffold a new site with simple to use commands.

Installation

You can install Konstruct Cli by running:

$ gem install konstruct

When it's installed simply run:

$ konstruct

Usage

The Cli has a few very simple commands. If you get stuck simply $ konstruct --help for help. You can also get instructions for every command with $ konstruct [COMMAND] --help

Available Commands

Scaffold

This feature is coming soon.

Gulp

$ konstruct gulp

Runs a default Gulp

Skeleton

$ konstruct skeleton

The skeleton command builds a basic starter project template for common website projects. It builds common folders to ensure your project is tidy and organised.

Stat

This feature is coming soon.

Documentation

$ konstruct documentation

Loads up the Konstruct Documentation in your default browser.

Init

$ konstruct init

Initialises the Cli by installing any libraries and extensions you might require to work with Konstruct. This command only runs once (usually when you run $ konstruct for the first time), and then simply displays a welcome screen.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/konstruct/konstruct.cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.