Skip to main content

Add your description here

Project description

DiffDog 🐕

DiffDog (invoked as bark) is a CLI tool that sniffs through your daily git commits across multiple repositories and uses LLM (Groq) to bark out a clean, formatted daily update summary. It automatically copies the result to your clipboard.

🛠 Installation

Using uv (Recommended)

uv tool install diffdog

Using pip

pip install diffdog

⚙️ Setup

You need a config.yaml file to get started.

  1. Get an API Key: Create a free key at https://console.groq.com/keys
  2. Create your config: Create a config.yaml with the following structure:
author: "Your Name"
groq_key: "gsk_xxxx..."
model: "llama-3.3-70b-versatile" # Optional
no_copy: false                  # Optional
repos:
  - "~/projects/work-app"
  - "~/projects/side-hustle"
titles:
  - "Work App"
  - "Side Project"
notes: # Optional
  - "The updates must sound like a rap"

Note: The author field must have either the name or email you commit with, it's used to get your commits from your repos. Note: The number of repos must match the number of titles.

  1. Initialize the tool:
bark -c path/to/your/config.yaml

🚀 Usage

Generate and copy summary to clipboard:

bark

Print summary without copying to clipboard:

bark --no-copy

Pass notes to the bot to customize the summary:

bark --note "The updates must sound like a rap"

View current configuration:

bark --show-conf

🔄 Updating Configuration

If you need to change your settings:

  1. Run bark --show-conf > config.yaml to save your current settings to a file.
  2. Edit the config.yaml file with your changes.
  3. Re-assign it by running bark -c config.yaml.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

diffdog-0.1.2.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

diffdog-0.1.2-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file diffdog-0.1.2.tar.gz.

File metadata

  • Download URL: diffdog-0.1.2.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for diffdog-0.1.2.tar.gz
Algorithm Hash digest
SHA256 49056daff6f1a7a221a0d2961da36979e84b44292fe10fb4dfb3a6be273d8aff
MD5 43f10b1ee6cb6dbdce36f060d8eda2b1
BLAKE2b-256 46539921c1cc66f47ff0b57989f3e529b124e72c6018a4f595ef43450fd57d2f

See more details on using hashes here.

File details

Details for the file diffdog-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: diffdog-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for diffdog-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 012c96cc7a6680dbdd7220ebf811128f062acedc14720a6353eac20345e42060
MD5 ad6c9f9ce9207d30bdde5eaa8aa12221
BLAKE2b-256 fe44dcb541954b4fa0afa27831eee59bf9cb79be136c2b24e3105a213cbf3506

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page