Skip to main content

This tool automatically generates pr details via an LLM

Project description

auto-detail

An AI powered CLI for automatically detailing software development projects.

Features

  • Simple Detailing: Quickly record notes about your work from the command line.
  • AI-Powered Commit Messages: Generate well-structured commit messages based on your recorded details.
  • Local Storage: All details are stored locally in simple YAML files.

Installation

  1. Install tool:

    pip install auto_detail
    
  2. Set up your environment: Create a Google Gemini API key. This is required for using the tool. A free tier is available and will usually suffice.

    auto_detail set_key GEMINI_API_KEY
    

Usage

All commands are run through the auto_detail CLI entrypoint.

Create a New Detail

The new command is your primary tool for writing notes with AI to summarize your changes.

auto_detail

or

auto_detail new

This creates a timestamped YAML file in the .detail/notes/ directory containing your note.

View Details

To see a list of all recorded details:

auto_detail list

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

auto_detail-0.3.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

auto_detail-0.3.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file auto_detail-0.3.0.tar.gz.

File metadata

  • Download URL: auto_detail-0.3.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.9 Darwin/24.6.0

File hashes

Hashes for auto_detail-0.3.0.tar.gz
Algorithm Hash digest
SHA256 078f6f0fcdd099be74942a65b596949a8131db6f9a50c8a4568183b06a12b8fb
MD5 17201e836ef44ae63276b264e3a0c991
BLAKE2b-256 986fc17f6a6018d1ca1959c2425170de6918f2f70523f5d04e486d6737235409

See more details on using hashes here.

File details

Details for the file auto_detail-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: auto_detail-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.9 Darwin/24.6.0

File hashes

Hashes for auto_detail-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e57aafb6fcb0c065c51ab022e5d14afee1e69831ac13a7181d3dab92eee9cd9c
MD5 87fffb200ccfb629ed472cc8022db158
BLAKE2b-256 9a16722ac99a72dec6099abc1d92efc82890c21ca99699c4bfcb24288aeebe14

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