This tool automatically generates PR details via an AI.
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
-
Install tool:
pip install auto_detail
-
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file auto_detail-0.4.0.tar.gz.
File metadata
- Download URL: auto_detail-0.4.0.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.4 CPython/3.12.9 Darwin/24.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
11eed6bcc2d2b85f05d4f98dc4f2de0737f2bbef37f19187ec9a869bfd75554b
|
|
| MD5 |
1e6222e087d9f964ed2baa4873b52303
|
|
| BLAKE2b-256 |
0b090b5f2b21c1eb9925d8473d56f9bdde9d81fc6c82e1b2ab9128e142deb7b6
|
File details
Details for the file auto_detail-0.4.0-py3-none-any.whl.
File metadata
- Download URL: auto_detail-0.4.0-py3-none-any.whl
- Upload date:
- Size: 13.8 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
528bc368e367e357d362c00e0611b38ef1c79a683ece67c112b781458324b9f5
|
|
| MD5 |
1cfe948241834209b4b65ae0acd5910c
|
|
| BLAKE2b-256 |
78868e45759820f2c1cb4a9a343396ff8e90580016557261e6d3ed2292e91059
|
