@fayolsmith/devscribe
v1.0.0
Published
An AI-powered CLI that plugs into your git workflow for conventional commits, PR descriptions, changelogs, and diff risk reviews.
Maintainers
Readme
DevScribe
An AI-powered CLI that plugs into your git workflow — generates conventional commit messages, PR descriptions, changelogs, and lightweight diff risk reviews.
Why
Writing a good commit message after a long debugging session is the last thing anyone wants to do — so it usually doesn't happen well. DevScribe reads your actual staged diff and drafts a proper conventional commit message, PR description, or changelog entry from it, so the record of what changed and why stays accurate without it being a chore.
Features
devscribe commit— generates a Conventional Commit message from staged changes, with an interactive accept / edit / regenerate promptdevscribe pr— diffs your branch against a base branch and writes a structured PR description (summary, key changes, testing notes); supports--copyor--ghto pipe straight intogh pr createdevscribe changelog— summarizes commits between two tags into release notes, updatingCHANGELOG.mddevscribe review— a fast heuristic + AI pass over a diff, flagging things like missing test coverage on large changes, TODOs left in, or secrets-looking strings- Multi-provider — Anthropic, OpenAI, Gemini, or fully local Ollama. Pick per
command with
--provider, or set a default once.
Demo
Real output from the CLI, tested against a local diff:
$ git add .
$ devscribe commit
Suggested Commit Message:
──────────────────────────────────────────────────
docs(README): update README with new information
──────────────────────────────────────────────────
? What would you like to do with this commit message?
❯ Accept and commit
Edit message manually
Regenerate message
CancelInstallation
npm install -g devscribeProvider Setup
Pick one provider and configure it — you don't need all four.
| Provider | Setup |
|-----------|-------|
| Anthropic (default) | export ANTHROPIC_API_KEY="sk-ant-..." or devscribe config set-key <key> |
| OpenAI | export OPENAI_API_KEY="sk-..." or devscribe config set-provider openai && devscribe config set-key <key> |
| Gemini | export GEMINI_API_KEY="AIzaSy..." or devscribe config set-provider gemini && devscribe config set-key <key> |
| Ollama (local, free, no key) | devscribe config set-provider ollama — just make sure ollama serve is running |
Check your active config anytime with devscribe config show.
Commands
Each command supports --provider to override the default for that run. Full option
list for any command:
devscribe <command> --helpdevscribe commit— commit message from staged diffdevscribe pr [--base <branch>] [--copy] [--gh]— PR title + descriptiondevscribe changelog [--from <tag>] [--to <tag>]— release notes intoCHANGELOG.mddevscribe review [--staged] [--base <branch>]— risk review of a diff
Testing
Ships with unit tests covering the git layer, prompt building, and all four provider adapters (instantiation + config validation — no live API calls). Live-provider behavior has been verified end-to-end against Ollama locally; Anthropic/OpenAI/Gemini adapters follow the same interface and are covered by config-level tests. Real-world testing against those live APIs is welcome via PR.
npm testLicense
MIT © 2026
