diffbro 1.0.0

Your personal AI assistant bro for better code reviews.

diffbro - AI charged Peer Reviews

Your AI Peer Review Bro

Features

• Different bro modes for chill, to chad engineer level peer reviews

  • chill: will review your code like a chill bro (default)
    • diffbro --chill
  • mid: will review your code like a mid level engineer bro
    • diffbro --mid
  • chad: will review your code like a chad, staff engineer bro
    • diffbro --chad

• Choose which files to review

  • Only .py and .js files
    • diffbro --only .py .js
  • Everything except .py and .js files
    • diffbro --ignore .py .js
  • Defaults to [".py", ".c", ".cpp", ".java", ".cs", ".php", ".vb", ".html", ".css", ".js", ".asp", ".aspx", ".cfm", ".cgi", ".pl", ".cer", ".htm", ".xhtml", ".shtml", ".jsp", ".jsx", ".tsx", ".vue", ".solid", ".toml", ".md", ".go", ".rs", ".swift"]

• Choose your gpt model

  • diffbro --model gpt-3.5-turbo
  • diffbro --model gpt-4 (default) (recommended for production code)

• Example command combos

  • 'I want a chill review on my .py and .js files'
    • diffbro --chill --only .py .js
  • 'I'm about to ship production, mission critical UI code, I need a hardcore review on my FE code'
    • diffbro --chad --model gpt-4 --only .js .jsx .tsx .vue
  • 'I'm about to a fullstack app and need a comprehensive mid level review on all my code excluding .tsx files'
    • diffbro --mid --model gpt-4 --ignore .tsx
  • 'I want legit reviews all the time'
    • Throw this line into your .bashrc or .bash_profile
      • alias dbro='diffbro --chad --model gpt-4'
    • Whenever you want a review, just run
      • dbro

Setup & Usage

• Install or switch to Python 3.11 or 3.10 or 3.9 or 3.8

  • Check your python version
    • python --version

• Install 'stable' version from PyPI

  • pip install --upgrade diffbro

• Export your openai api key

  • Copy .env.sample -> .env file in your project root
    • cp .env.sample .env
  • Update .env to contain your openai api key
  • OR
  • export OPENAI_API_KEY=<your-openai-api-key>

• Make changes to your codebase

• Before you commit, run diffbro

  • diffbro

• Implement the feedback from diffbro

• Commit your code with confidence

• View all commands, options and examples

  • diffbro --help

Install bleeding edge version test version

• Install BLEEDING EDGE version from TestPyPi
  • pip install --upgrade --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple diffbro

Local Dev Commands (excluded from dist)

• run diffbro locally
  • poetry run diffbro
• test versions
  • poetry run python scripts/run_tox.py
• publish to test pypi
  • poetry run python scripts/publish_testpypi.py
• publish to pypi
  • poetry run python scripts/publish_pypi.py

ROADMAP

[✅] POC

[✅] Add GPT model flag

[✅] Add diff exclusion of large files like poetry.lock from the diff

[✅] Add cli --only flag to diff only specific file types

[✅] Add cli --ignore flag to ignore specific file types

[✅] Deploy version 0.1.0 to TestPyPi

[✅] Test install version 0.1.0 from TestPyPi

[✅] Deploy version 0.1.2 to pypy

[✅] Add help docs

[✅] Support additional python versions

[✅] Improve openai_api_key check

[✅] Chad should always ask to use gpt-4 (simple yes/no prompt)

[✅] Add custom prompt flag to be run on the diff diffbro --prompt "Below is a git diff of code. Please review and notify only of critical issues."

[✅] Add summarybro flag that will create a git commit message using the diffbro summary diffbro --summarize -> "Added new feature to the app, fixed a bug, and refactored some code."

[✅] Add COMPLETE PR review flag which runs diffbro against a branch and creates a PR review diffbro --pr main

[] RELEASE VERSION 1.0.0!!!

• Next

  [] Add token limit check to prevent overage charges

  [] Add 'AI Devlogs' section to readme w/links to ai devlogs

  [] Add ~/.diffbro config file support for defaults

  • if a cli param was specified, use that. Add default values to detect if a cli param was specified (dirty)
  • add new 'custom' param to cli to use custom config