pizza-cli

command module
v0.0.1-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2023 License: MIT Imports: 3 Imported by: 0

README

🍕 Pizza CLI

This CLI can be used 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.

🖥️ Local Development

You'll need a few tools to get started:

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

🏗️ Installation
Manual build and install
make install

This is a convenience 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>.

In the future, we will be dropping regular GitHub releases where you can easily download and install pre-built binaries.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
bake
Package bake contains the bootstrapping and tooling for the pizza bake cobra command
Package bake contains the bootstrapping and tooling for the pizza bake cobra command
root
Package root initiates and bootstraps the pizza CLI root Cobra command
Package root initiates and bootstraps the pizza CLI root Cobra command
pkg
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL