omg

Open Microservice CLI

Verify, test, and execute microservices built with the OMG standard.

Overview

The goals of this project is to provide a utility for developers to test/execute their microservices before being used in a production environment.

Installation

npm install -g omg

Commands

omg validate

  Usage: validate [options]

  Validate the structure of a `microservice.yml` in the current directory

  Options:

    -j --json    Formats output to JSON
    -s --silent  Only feedback is the status exit code
    -h, --help   output usage information

omg build

  Usage: build [options]

  Builds the microservice defined by the `Dockerfile`. Image will be tagged with `omg/$gihub_user/$repo_name`, unless the tag flag is given. If no git config present a random string will be used

  Options:

    -t --tag, <t>  The tag name of the image
    -h, --help     output usage information

omg run

  Usage: run [options] <action>

<<<<<<< HEAD
  Run actions defined in your `microservice.yml`. Must be run in a directory with a `Dockerfile` and a `microservice.yml`
=======
  Run actions defined in your `microservice.yml`. Must be ran in a directory with a `Dockerfile` and a `microservice.yml`
>>>>>>> 9a82584f458e73978f00b90d34ef25f17b6b81de

  Options:

    -i --image <i>  The name of the image to spin up the microservice, if not provided a fresh image will be build based of the `Dockerfile`
    -a --args <a>   Arguments to be passed to the command, must be of the form `key="val"` (default: )
    -e --envs <e>   Environment variables to be passed to run environment, must be of the form `key="val"` (default: )
    -r --raw        All logging is suppressed expect for the output of the action.
    -h, --help      output usage information

omg subscribe

  Usage: subscribe [options] <action> <event>

<<<<<<< HEAD
  Subscribe to an event defined in your `microservice.yml`. Must be run in a directory with a `Dockerfile` and a `microservice.yml`
=======
  Subscribe to an event defined in your `microservice.yml`. Must be ran in a directory with a `Dockerfile` and a `microservice.yml`
>>>>>>> 9a82584f458e73978f00b90d34ef25f17b6b81de

  Options:

    -a --args <a>  Arguments to be passed to the event, must be of the form `key="val"` (default: )
    -e --envs <e>  Environment variables to be passed to run environment, must be of the form `key="val"` (default: )
    -h, --help     output usage information

omg shutdown

  Usage: shutdown [options]

  Shutdown a microservice process that was started by an event command

  Options:

    -h, --help  output usage information

omg ui

  Usage: ui [options]

  Starts the OMG app using the omg-ui

  Options:

    --no-open does not open the UI in another tab, you will need to open it yourself

    -p --port Manually choose on which port you want to start the UI

More information can be found in the docs.