🐦
🐦
🐦
🐦
Kerbi
Search…
Welcome
Guides
Getting Started
Walkthrough
The Mixer API
The Templating API
Releases & States
Revisions
CLI Reference
Global Configuration
Powered By GitBook
Getting Started
Install Kerbi, create a project, and generate your first manifest.
Kerbi is a Ruby gem. It comes with code, which you use for your kerbi projects, and an executable, which is a convenient command line interface. Here, we'll install the gem and generate a project.

1. Install the Gem

Start by installing the kerbi gem globally:
$ gem install kerbi
You can now run the kerbi executable from anywhere:
$ kerbi
Commands:
kerbi config # Command group for config actions (see $ kerbi config help)
kerbi console # Opens an IRB console so you can play with your mixers
kerbi help [COMMAND] # Describe available commands or one specific command
kerbi project # Command group for project actions (see $ kerbi project help)
kerbi release # Command group for release actions (see $ kerbi release help)
kerbi state # Command group for state actions (see $ kerbi state help)
kerbi template [RELEASE_NAME] [PROJECT_URI] # Templates to YAML/JSON, using [RELEASE_NAME] for state I/O
kerbi values # Command group for values actions (see $ kerbi values help)
kerbi version # Print the kerbi gem's version.

2. Generate a Boilerplate Project

Move to your desired workspace and run kerbi's boilerplate project generator command:
$ kerbi project new hello-kerbi
Inspect the newly created project, and optionally, run the bundler:
$ cd hello-kerbi
$ bundle install

3. Run Basic Commands

Get familiar with the command line API by running the two most basic commands, starting with template:
$ kerbi template hello .
And then values show to see compiled values in action:
$ kerbi values show --set pod.image=ruby

​

Previous
Welcome
Next - Guides
Walkthrough
Last modified 3mo ago
Copy link
Outline
1. Install the Gem
2. Generate a Boilerplate Project
3. Run Basic Commands