> For the complete documentation index, see [llms.txt](https://xavier-9.gitbook.io/kerbi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xavier-9.gitbook.io/kerbi/guides/getting-started.md).

# Getting Started

Kerbi is a Ruby [gem](https://www.ruby-lang.org/en/libraries/). 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:

```bash
$ gem install kerbi
```

You can now run the `kerbi` executable from anywhere:

```bash
$ 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
```

##