The msplat cli is a command line interface for managing a microservices platform using the msplat concept. This project is very new and hasn't even reached it's alpha version.

Tutorials

The wiki has some tutorials and getting started guides for creating your first msplat environment.

• Create a new Development Environment
• Create a new Production Environment
• ...more tutorials

Install

You can install a prebuilt binary to use on several platforms.

The below code will work on a linux (amd64) machine.

curl -L https://github.com/msplat/msplat-cli/releases/download/v0.0.4/mtk-v0.0.4-linux-amd64 --output mtk
sudo cp mtk /usr/local/bin/mtk
sudo chmod +x /usr/local/bin/mtk

Usage

Before using the cli you will need to define the config file for the environment.

You can do this by specifying the MSPLAT_CONFIG environment variable or providing a --config flag.

$ export MSPLAT_CONFIG=~/Documents/example/config.yml
$ mtk --help

NAME:
   msplat toolkit - A cli for managing msplat environments
USAGE:
   mtk [global options] command [command options] [arguments...]

COMMANDS:
   projects, pr         Tasks for managing projects
   services, sv         Tasks for managing services
   stacks, st           Tasks for managing stacks
   help, h              Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config value  configuration settings for msplat (default: "?cwd") [$MSPLAT_CONFIG]
   --help, -h      show help
   --version, -v   print the version

VERSION:
   0.0.4

Autocomplete

The CLI comes with autocomplete functionality. To activate it you will need to run the following for every shell. Alternatively you can add it to your .bashrc file.

cd dist && PROG=mtk source ../autocomplete/bash_autocomplete

Build

Alternatively you can build the binary yourself from source.

You will need go version 1.11.4 or higher, as this project uses go modules.

To build you can execute the build.sh file in the root of the project:

## To build ignoring autocomplete
./build.sh

## To build and activate autocomplete in the active shell
. ./build.sh

This will produce a binary at dist/mtk which can be installed globally:

sudo ln -s `pwd`/dist/mtk /usr/local/bin/mtk

Contributing

Linting code

Make sure your code is following the official go formatting guidelines by running the command below. The tests will fail if there are outstanding formatting errors.

gofmt -w .

License

This project is licensed under the terms of the GPLv3 license.