brev-cli

README

Brev CLI

Star this repository if you find it valuable and worth maintaining.

Watch this repository to get notified about new releases, issues, etc.

Install

!!! warning these commands run as sudo !!!

Linux & Mac

curl -sf -L https://raw.githubusercontent.com/brevdev/brev-cli/main/bin/install-latest.sh  -o install-brev.sh
chmod +x install-brev.sh
sudo ./install-brev.sh

or

curl -sf -L https://raw.githubusercontent.com/brevdev/brev-cli/main/bin/install-latest.sh | sudo sh

Uninstall

sudo rm /usr/local/bin/brev
rm -rf ~/.brev

Usage

Completion

zsh

brev completion zsh | sudo tee /usr/local/share/zsh/site-functions/brev

bash

brev completion bash > /usr/local/etc/bash_completion.d/brev

Development

Build

make build

example .env file

VERSION=unknown
BREV_API_URL=http://localhost:8080
# BREV_API_URL=https://ade5dtvtaa.execute-api.us-east-1.amazonaws.com

Terminal

• make - execute the build pipeline.
• make help - print help for the Make targets.

Visual Studio Code

F1 → Tasks: Run Build Task (Ctrl+Shift+B or ⇧⌘B) to execute the build pipeline.

Release

The release workflow is triggered each time a tag with v prefix is pushed.

CAUTION: Make sure to understand the consequences before you bump the major version. More info: Go Wiki, Go Blog.

Maintainance

Remember to update Go version in .github/workflows, Makefile and devcontainer.json.

Notable files:

• devcontainer.json - Visual Studio Code Remote Container configuration,
• .github/workflows - GitHub Actions workflows,
• .github/dependabot.yml - Dependabot configuration,
• .vscode - Visual Studio Code configuration files,
• .golangci.yml - golangci-lint configuration,
• .goreleaser.yml - GoReleaser configuration,
• Dockerfile - Dockerfile used by GoReleaser to create a container image,
• Makefile - Make targets used for development, CI build and .vscode/tasks.json,
• go.mod - Go module definition,
• tools.go - build tools.

Contributing

Simply create an issue or a pull request.

Distribute to Homebrew

Step 1: bump version (see top of Makefile)

Step 2: create homebrew distribution

> make dist-homebrew

Step 3: create GitHub release

Step 4: upload resultant tar.gz to GitHub release

Step 5: copy sha256 (output from step 2) and use it in a new update to https://github.com/brevdev/homebrew-tap