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.

Key Features

• Set up a new project structure in seconds.
• Scaffold out a new HTML, Jekyll or Angular site in seconds.
• Globally installed Gulp with Konstruct.gulp.
• Develop with SASS, Browserify (CommonJS).
• Build process to optimise assets for deployment in separate git branches.
• Quick link to Konstruct Documentation.

Installation

You can install Konstruct Cli by running:

$ gem install konstruct

Commands

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

Konstruct Commands

• $ konstruct folders
• $ konstruct create
• $ konstruct refresh
• $ konstruct watch
• $ konstruct build
• $ konstruct documentation

Folders

$ konstruct folders

Scaffolds a set of project folders from a template to help you organise your project better.

Customize Template: You can customize the folder structure in ~/.konstruct/config.yml.

Create

$ konstruct create

Creates a new Konstruct starter project through an interactive wizard.

Refresh

$ konstruct refresh

Refreshes the project by installing dependencies again. Useful if you inherit a repo from another developer.

Watch

$ konstruct watch

Runs the global Gulp tools from your current working directory.

Build

$ konstruct build [options]

Options:

• --staging : Run build process on staging branch.
• --production : Run build process on production branch.

Runs build scripts & optimisations on your codebase in the branches you specified in options.

Currently optimising:

• Minify JS
• Minify CSS
• Optimise images

Documentation

$ konstruct documentation

Loads up the Konstruct Documentation in your default browser.

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.