Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshbainbridge/aibro
A CLI tool you can pipe code and then ask for changes, add documentation, etc, using the OpenAI API.
https://github.com/joshbainbridge/aibro
Last synced: 13 days ago
JSON representation
A CLI tool you can pipe code and then ask for changes, add documentation, etc, using the OpenAI API.
- Host: GitHub
- URL: https://github.com/joshbainbridge/aibro
- Owner: joshbainbridge
- Created: 2023-08-20T12:49:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-05T21:53:51.000Z (10 months ago)
- Last Synced: 2024-08-01T22:57:48.379Z (3 months ago)
- Language: Rust
- Homepage:
- Size: 32.2 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AiBro
This is your own little coding bro, immersed in the world of AI, crypto, and all
other types of over hyped tech trends. You can pipe it code and request changes,
add documentation, etc. This can be useful when combined with editors that
support piping text like [Helix](https://helix-editor.com).
AiBro uses the [OpenAI](https://platform.openai.com/docs/api-reference) HTTP
interface to answere queries. You will need to setup an OpenAI account and
acquire an authentication key before getting a responce.
## Environment variables:
- `OPENAI_API_KEY`: API key for authentication. Alternatively this can be set or
overriden using a command argument. See the [usage](#usage) section below.
- `AIBRO_DEFAULT_PROMPT`: Optional default fallback prompt for common requests
when piping in code. For example 'return code with documentation'.
## Installation
Either setup a rust toolchain manually, or if you are using macOS and have Nix
installed, use the provided Nix flake to create a development environment:
```bash
nix develop
```
Installation of the CLI command can then be done using cargo:
```bash
cargo install --path .
```
## Usage
````
Usage: aibro [OPTIONS] [PROMPT]...
Arguments:
[PROMPT]...
Input prompt [override: $AIBRO_DEFAULT_PROMPT]
Options:
-b, --bro
Selected aibro persona
[default: coder]
Possible values:
- coder: Helpful coding assistant
- chad: Over hyped Chad GPT bro
- grandma: Old lady grandma bro
-m, --model
Selected ML model
[default: gpt3]
Possible values:
- gpt3: GPT 3.5 turbo model
- gpt4: GPT 4.0 model
-t, --temperature
Model temperature
[default: 0.3]
-a, --auth
Authentication key [override: $OPENAI_API_KEY]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
````