https://github.com/threeal/bro

Your friendly, personal, multi-purpose buddy written in Go
https://github.com/threeal/bro

assistant bot buddy go golang multipurpose multipurpose-bot

Last synced: 12 months ago
JSON representation

Your friendly, personal, multi-purpose buddy written in Go

• Host: GitHub
• URL: https://github.com/threeal/bro
• Owner: threeal
• License: mit
• Created: 2022-12-09T13:28:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-20T01:37:26.000Z (over 1 year ago)
• Last Synced: 2025-03-18T11:51:57.762Z (about 1 year ago)
• Topics: assistant, bot, buddy, go, golang, multipurpose, multipurpose-bot
• Language: Go
• Homepage:
• Size: 355 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Bro

[![build status](https://img.shields.io/github/actions/workflow/status/threeal/bro/build.yml?branch=main)](https://github.com/threeal/bro/actions/workflows/build.yml)

[![tests status](https://img.shields.io/testspace/pass-ratio/threeal/threeal:bro/main)](https://threeal.testspace.com/projects/threeal:bro)

[![coverage status](https://img.shields.io/coveralls/github/threeal/bro/main)](https://coveralls.io/github/threeal/bro)

Your friendly, personal, multi-purpose [buddy](https://en.wiktionary.org/wiki/buddy) written in [Go](https://go.dev/).

## Build

- Requirements: [Go](https://go.dev/doc/install), [Protocol Compiler](https://github.com/protocolbuffers/protobuf#protocol-compiler-installation) (Protobuf's protoc).

- Generate sources from `*.proto` files.

    ```sh

    go generate ./pkg/...

    ```

- (Optional) Build targets.

    ```sh

    go build ./cmd/...

    ```

## Usage

### Backend Server

- Run backend server.

    ```sh

    go run ./cmd/bro-backend spin

    ```

    You will be prompted to input the listen address if there is no config file.

    The config file will be located in `$HOME/.bro/backend_config.json`.

- Show help.

    ```sh

    go run ./cmd/bro-backend

    ```

### CLI Client

- Run CLI client.

    ```sh

    go run ./cmd/bro --help

    ```

    You will be prompted to input the backend address if there is no config file.

    The config file will be located in `$HOME/.bro/config.json`.