cli

Get started with brwne

About

brwne is a command-line tool designed to make collaborating on code intuitive, lightweight, and fast. It streamlines your Git workflow, allowing you to spend less time on repo management and more time coding.

Demo

br status command demo

The br status command shows your current branch and any uncommitted changes.

Getting Started

Installation

macOS (via Homebrew)

If you're on macOS, the easiest way to install brwne is with Homebrew.

brew tap the-pirateship/brwne
brew install brwne

Linux

Download the latest release from GitHub or:

curl -SLo ~/.local/bin/br \
  https://github.com/the-pirateship/brwne-releases/releases/latest/download/br_linux_amd64
chmod +x ~/.local/bin/br

Windows

Coming soon.

Usage

Once brwne is installed, getting started is simple.

  1. Login to your account: This command will open a browser window to authenticate you with GitHub.
    br login
    
  2. Activate brwne in your repository: Navigate to the Git repository you want to work on and run:
    br activate
    

That's it! You're now ready to use brwne to manage your workflow.

Commands

For a full list of commands, see the sidebar.

Roadmap

Our public roadmap will be available soon.

Changelog