cli

README

Bopmatic CLI

The Bopmatic CLI is a set of tools & utilities for interacting with Bopmatic projects from the shell.

Building

make

Installing

The Bopmatic CLI depends on docker being installed and runnable as non-root.

Linux

Note these instructions and the CLI should work on any Linux distribution, but have only been explicitly tested on Ubuntu 20.04 LTS.

$ BOPURL=$(curl -s https://api.github.com/repos/bopmatic/cli/releases/latest | grep browser_download_url | cut -f2,3 -d: | tr -d \")
$ wget $BOPURL
$ chmod 755 bopmatic
$ sudo mv bopmatic /usr/local/bin

MacOS

$ brew install bopmatic/macos/cli

Windows

1. Install WSL 2 (https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi)
2. Set WSL default version

wsl –set-default-version 2

1. Install Ubuntu 20.04 on WSL 2 (https://www.microsoft.com/store/apps/9n6svws3rx71)
2. Open an Ubuntu terminal window and follow Linux install instructions above

Usage

Bopmatic - The easy button for serverless

To begin working with Bopmatic, run the `bopmatic new` command:

    $ bopmatic new

This will prompt you to create a new project in your language of choice.

The most common commands from there are:

    - bopmatic package build    : Build your project locally
    - bopmatic package deploy   : Send your project to Bopmatic ServiceRunner for deployment
    - bopmatic package describe : Request details regarding your deployed package
    - bopmatic package destroy  : Remove a previously sent deployment from Bopmatic ServiceRunner

For more information, please visit the project page: https://www.bopmatic.com/docs/

Usage:
  bopmatic [command]

Available Commands:
  describe       Describe the contents of a Bopmatic project
  package        Create, Deploy, Destroy, or List Bopmatic project packages
                   run 'bopmatic package help' for more details
  help           This help screen
  config         Set Bopmatic configuration
  new            Create a new Bopmatic project
  version        Print Bomatic CLI's version number
  upgrade        Upgrade Bopmatic CLI to the latest version

Common Flags:
  --projfile                         Bopmatic project file; defaults to Bopmatic.yaml

Contributing

Pull requests are welcome at https://github.com/bopmatic/cli

For major changes, please open an issue first to discuss what you would like to change.

License

AGPL3