update readme
This commit is contained in:
5 files changed
+22
-53
No files matched your search
@@ -34,14 +34,14 @@ DevGen is a CLI for the parts of development that should be invisible. It writes
|
|||||||
|
|
||||||
## Supported AI Providers
|
## Supported AI Providers
|
||||||
|
|
||||||
| Provider | Notes |
|
| Provider | Notes |
|
||||||
|---|---|
|
| ----------------- | ---------------------------------------------------- |
|
||||||
| **Google Gemini** | Default-friendly, generous free tier |
|
| **Google Gemini** | Default-friendly, generous free tier |
|
||||||
| **OpenAI** | GPT-4o, GPT-4.1, o-series |
|
| **OpenAI** | GPT-4o, GPT-4.1, o-series |
|
||||||
| **Anthropic** | Claude 3.5 / 3.7 / 4 |
|
| **Anthropic** | Claude 3.5 / 3.7 / 4 |
|
||||||
| **OpenRouter** | Single key, many models |
|
| **OpenRouter** | Single key, many models |
|
||||||
| **HuggingFace** | Inference API |
|
| **HuggingFace** | Inference API |
|
||||||
| **Ollama** | Fully local, no API key, no data leaves your machine |
|
| **Ollama** | Fully local, no API key, no data leaves your machine |
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -80,17 +80,17 @@ devgen commit run --push
|
|||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|---|---|
|
| ------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `devgen setup config` | Interactive provider / API key / options wizard |
|
| `devgen setup config` | Interactive provider / API key / options wizard |
|
||||||
| `devgen commit run` | Stage, generate message, commit (optionally `--push`, `--check`, `--dry-run`) |
|
| `devgen commit run` | Stage, generate message, commit (optionally `--push`, `--check`, `--dry-run`) |
|
||||||
| `devgen commit undo` | Undo the last AI commit, keep changes staged |
|
| `devgen commit undo` | Undo the last AI commit, keep changes staged |
|
||||||
| `devgen changelog` | Generate a Conventional Commits changelog from recent history |
|
| `devgen changelog` | Generate a Conventional Commits changelog from recent history |
|
||||||
| `devgen release-notes` | Generate release notes for a version range |
|
| `devgen release-notes` | Generate release notes for a version range |
|
||||||
| `devgen gitignore list` | List available GitHub `.gitignore` templates |
|
| `devgen gitignore list` | List available GitHub `.gitignore` templates |
|
||||||
| `devgen gitignore add <name> …` | Add `.gitignore` entries to the current project |
|
| `devgen gitignore add <name> …` | Add `.gitignore` entries to the current project |
|
||||||
| `devgen license list` | List available SPDX licenses |
|
| `devgen license list` | List available SPDX licenses |
|
||||||
| `devgen license add <spdx>` | Add a LICENSE file to the current project |
|
| `devgen license add <spdx>` | Add a LICENSE file to the current project |
|
||||||
|
|
||||||
Run `devgen <command> --help` for full options on any subcommand.
|
Run `devgen <command> --help` for full options on any subcommand.
|
||||||
|
|
||||||
@@ -142,7 +142,6 @@ Built on the shoulders of:
|
|||||||
|
|
||||||
- **Typer** & **Rich** — CLI and terminal UI
|
- **Typer** & **Rich** — CLI and terminal UI
|
||||||
- **Questionary** — interactive prompts
|
- **Questionary** — interactive prompts
|
||||||
- **Jinja2** — template rendering under the hood
|
|
||||||
- **Google Gemini**, **OpenAI**, **Anthropic**, **OpenRouter**, **HuggingFace**, and **Ollama** — AI providers
|
- **Google Gemini**, **OpenAI**, **Anthropic**, **OpenRouter**, **HuggingFace**, and **Ollama** — AI providers
|
||||||
- **Ruff** — lint and format
|
- **Ruff** — lint and format
|
||||||
|
|
||||||
|
|||||||
@@ -1,30 +0,0 @@
|
|||||||
# 📋 Project Roadmap & TODOs
|
|
||||||
|
|
||||||
This document outlines future improvements, features, and technical debt for `devgen`.
|
|
||||||
|
|
||||||
## 🚀 Priority: Short-Term (Reliability & DX)
|
|
||||||
- [ ] **Full Test Suite**: Implement `pytest` for all modules, especially `commit_generator` and `utils`.
|
|
||||||
- [x] **Interactive Commit Review**: Add a `--check` flag to `devgen commit run` that allows users to approve/edit the AI message before committing.
|
|
||||||
- [ ] **Project-Level Config**: Support `.devgen.yaml` in the repository root that overrides global `~/.devgen.yaml`.
|
|
||||||
- [ ] **Improved Gitignore Detection**: Auto-detect project type (Python, Node, Go) and suggest relevant `.gitignore` templates during `devgen gitignore run`.
|
|
||||||
|
|
||||||
## 🤖 AI & Intelligence
|
|
||||||
- [x] **Custom Prompts**: Allow users to define their own Jinja2 templates for commits in the config file(~/.devgen.yaml).
|
|
||||||
- [x] **Context-Aware Commits**: Send the manifest file (`package.json`, `pyproject.toml`) to the AI to provide better context for dependency changes.
|
|
||||||
- [ ] **Token Usage Dashboard**: Add a `devgen config tokens` command to estimate or track AI token consumption.
|
|
||||||
- [ ] **More Providers**: Add support for **Mistral**, **Cohere**, and **Groq** for faster/cheaper generations.
|
|
||||||
|
|
||||||
## 🛠️ Developer Experience (DX)
|
|
||||||
- [ ] **Pre-commit Hook Integration**: Provide a command to easily install `devgen` as a pre-commit hook.
|
|
||||||
- [x] **Shell Completion**: Implement `typer` shell completion for `bash`, `zsh`, and `fish`.
|
|
||||||
- [x] **Commit Undo**: `devgen commit undo` to easily revert the last AI-generated commit and unstage files.
|
|
||||||
- [x] **Multi-Group Commits**: Better handling of repositories where changes are spread across many unrelated directories.
|
|
||||||
|
|
||||||
## 🏗️ Refactoring & Technical Debt
|
|
||||||
- [ ] **Code Split**: Move CLI logic out of `devgen/cli` into separate service classes to improve testability.
|
|
||||||
- [ ] **Consistent Logging**: Standardize log output across all modules.
|
|
||||||
- [ ] **API Documentation**: Use Sphinx or MkDocs to generate documentation for the core modules.
|
|
||||||
|
|
||||||
## 🌍 Ecosystem
|
|
||||||
- [ ] **GitHub Action**: Create an official `devgen` GitHub Action for automated changelog updates on PR merge.
|
|
||||||
- [ ] **VS Code Extension**: A simple extension to trigger `devgen commit` from the sidebar.
|
|
||||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "devgen-cli"
|
name = "devgen-cli"
|
||||||
version = "0.2.4"
|
version = "0.2.5"
|
||||||
description = "A collection of developer tools"
|
description = "A collection of developer tools"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ from setuptools import find_packages, setup
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="devgen-cli",
|
name="devgen-cli",
|
||||||
version="0.2.4",
|
version="0.2.5",
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
include_package_data=True,
|
include_package_data=True,
|
||||||
install_requires=[
|
install_requires=[
|
||||||
|
|||||||
@@ -180,7 +180,7 @@ wheels = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "devgen-cli"
|
name = "devgen-cli"
|
||||||
version = "0.2.4"
|
version = "0.2.5"
|
||||||
source = { editable = "." }
|
source = { editable = "." }
|
||||||
dependencies = [
|
dependencies = [
|
||||||
{ name = "anthropic" },
|
{ name = "anthropic" },
|
||||||
|
|||||||
Reference in new issue
Block a user