Getting Started

Quick start

You can get started with microbs in three basic steps:

1. Prepare your environment
2. Install microbs
3. Configure microbs

Once installed and configured, you can use the CLI to run commands with microbs.

Step 1. Prepare your environment

Operating system

microbs has been tested on MacOS 12.1+. Your mileage may vary on other operating systems. Linux may work, but Windows is expected not to work.

Software dependencies

You will need to install node, docker, kubectl, and skaffold before installing microbs.

microbs has been tested with the following software versions:

Step 2. Install microbs

Run the following command:

curl -Ls https://microbs.io/install.js | node

This will do a few things:

• microbs will be available as an executable file in your $PATH
• $HOME/.microbs will be created to store deployment information
• $HOME/.microbs/config.yaml will be created to configure microbs
• All official apps and plugins will be installed

Step 3. Configure microbs

Open $HOME/.microbs/config.yaml in a text editor and complete the configuration. Don't forget to install any dependencies for the plugins you wish to use. You can run microbs validate to check if you have correctly prepared the environment for your plugins.

What's next?

Once installed and configured, refer to the CLI for an explanation of how to run microbs commands.