jpmcb / pizza-cli

A CLI for all things OpenSauced

🍕 Pizza CLI 🍕

A Go command line interface for all things OpenSauced!

❯ pizza

A command line utility for insights, metrics, and all things OpenSauced

Usage:
  pizza <command> <subcommand> [flags]

Available Commands:
  bake        Use a pizza-oven to source git commits into OpenSauced
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  login       Log into the CLI application via GitHub
  repo-query  Ask questions about a GitHub repository

Flags:
  -h, --help   help for pizza

Use "pizza [command] --help" for more information about a command.

---

📦 Install

There are several methods for downloading and installing the pizza CLI:

Homebrew

brew install open-sauced/tap/pizza

NPM

npm i -g pizza

Direct script install

curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh | sh

This is a convenience script that can be downloaded from GitHub directly and piped into sh for conveniently downloading the latest GitHub release of the pizza CLI.

Once download is completed, you can move the binary to a convenient location in your system's $PATH.

Warning

It may not be advisable to pipe scripts from GitHub directly into a command line interpreter! If you do not fully trust the source, first download the script, inspect it manually to ensure its integrity, and then run it:

curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh > install.sh
vim install.sh
./install.sh

Manual build and install

make install

This is a convenience make target for building and dropping the pizza CLI into /usr/local/bin/ (which requires sudo permissions). Make sure you have that directory in your path: export PATH="$PATH:/usr/local/bin". Otherwise, you can build it manually with make build and mv build/pizza <somewhere-in-your-path>.

🖥️ Local Development

You'll need a few tools to get started:

• The Go toolchain
• Docker (for linting and other tooling)
• Make

To lint, run make lint. To run tests, run make test. To build, run make build.