📝 575 Haiku Commit

Generate 5-7-5 haiku commit messages using AI! Transform your git commits into poetic works of art.

Table of Contents

• Features
• Installation
• Setup
• Usage
• Requirements
• Extension Settings
• Troubleshooting
• Privacy & Security
• Development
• Manual Validation
• Logging & Diagnostics
• Release Prep
• Learning Guides
• Roadmap
• Gallery
• Maintainers
• Support
• Versioning

Pull request whispers
Five–seven–five logs the change
Tests nod in silence

Features

• 🎋 Generate commit messages in traditional haiku format (5-7-5 syllables)
• 🤖 Multiple providers: Anthropic, OpenAI GPT‑5, and Google Gemini 2.5
• ⚡ Quick keyboard shortcut: Ctrl+Shift+H (or Cmd+Shift+H on Mac)
• 📝 Automatically fills in the Source Control commit message box
• 🎨 Works with any git repository

Installation

From Marketplace

• Install from the VS Code Marketplace: 575 Haiku Commit
• Or via CLI: code --install-extension AIMatey.575-haiku-commit

From Source

1. Clone this repository
2. Run pnpm install to install dependencies
3. Run pnpm run compile to build the extension
4. Press F5 in VS Code to open a new window with the extension loaded

Success check

• Open Command Palette → type "Haiku Commit" → you should see:
  • "Generate Haiku Commit Message"
  • "Set Haiku Provider"
  • "Set Haiku API Key"

Publishing to VS Code Marketplace

1. Install vsce: npm install -g @vscode/vsce
2. Package the extension: vsce package
3. Publish: vsce publish

Note: Do not commit .vsix artifacts. Keep built packages local; the CI validates builds, and releases are tracked via tags and GitHub Releases.

Why this exists

You already write commits. We make them readable, memorable, and consistent. If you stage small, meaningful diffs, 575 Haiku Commit gives you a crisp 5‑7‑5 commit that teams remember and can skim fast. Ideal for solo builders and teams that want consistent narrative commits without bikeshedding.

Setup

1. Choose a provider in Settings (haikuCommit.provider): anthropic, openai, or gemini. If unset, the extension will prompt you to choose one on first use.
2. Get an API key for the selected provider:
   • Anthropic: Anthropic Console
   • OpenAI: OpenAI API Keys
   • Gemini: Google AI Studio
3. Open VS Code Settings (Ctrl+, or Cmd+,)
4. Search for "Haiku Commit"
5. Enter the matching API key (the “Set Haiku API Key” command prompts for the right one)

Or the extension will prompt you for your API key on first use.

Usage

Method 1: Keyboard Shortcut

1. Stage your changes in git
2. Press Ctrl+Shift+H (Windows/Linux) or Cmd+Shift+H (Mac)
3. Watch as a beautiful haiku appears in your commit message box! 🌸

Method 2: Command Palette

1. Stage your changes in git
2. Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
3. Type "Generate Haiku Commit Message"
4. Press Enter

Method 3: Source Control Button

1. Stage your changes in git
2. Look for the haiku button in the Source Control panel title bar
3. Click it to generate a haiku

Multiple Options (Samples)

If you set haikuCommit.samples to a value greater than 1 (max 5), the extension will generate multiple haikus and present a selection list. Pick your favorite and it will be placed in the SCM input box.

Requirements

• VS Code 1.80.0 or higher
• Git repository
• API key for your selected provider:
  • Anthropic when provider=anthropic
  • OpenAI when provider=openai
  • Gemini when provider=gemini

Extension Settings

Configurable: provider, model, strict 5‑7‑5, samples, token and retry limits.

When strict mode cannot be satisfied after retries, you can choose to use the best attempt, try again, or cancel.

Data sharing by provider

This extension only sends your staged git diff to the selected AI provider to generate a haiku. Nothing else is transmitted.

• Anthropic: requests are sent to https://api.anthropic.com/v1/messages
• OpenAI: requests are sent to https://api.openai.com/v1/responses
• Gemini: requests are sent to Google AI Studio endpoints (models ...:generateContent)

Review your chosen provider’s terms and data policies before use.

575-haiku-commit/
├── src/
│   └── extension.ts      # Main extension code
├── package.json           # Extension manifest
├── tsconfig.json          # TypeScript configuration
└── README.md              # This file

Development

1. Clone the repository
2. Run pnpm install
3. Open in VS Code
4. Press F5 to start debugging
5. Make changes to src/extension.ts
6. Reload the extension window to see changes

For coding agents: follow the streamlined workflow in AGENTS.md for install, watch build, validation, and release preflight steps.

Manual Validation

Run this quick smoke test before publishing or cutting a release tag:

1. pnpm run release:verify — runs secret scanning, rebuilds out/, and executes scripts/test-validate.js.
2. Launch the Extension Development Host (F5) and generate at least one haiku against a staged diff.
3. Toggle each provider command (Set API Key, Set Provider, Set Model) to confirm prompts and status-bar affordances behave.
4. Capture a screenshot or short GIF if UI changed; stash it in media/ for the release notes.

Document your manual steps in the PR or release notes so reviewers can replay them.

Logging & Diagnostics

• Default runs are quiet. Startup now logs at debug level only, so the output channel stays silent unless you opt in.
• Enable verbose logs via the haikuCommit.debug setting or run "Haiku Commit: Show Logs" to surface the output channel.
• When collecting diagnostics for a bug, include provider, model, strict575 value, and whether generation hit retries.

Release Prep

• Run pnpm run release:verify locally (or in CI) before publishing.
• Follow the detailed checklist in docs/RELEASE_PREP.md covering Marketplace packaging, tag pushes, and visibility flips.
• Verify the README Roadmap and screenshots reflect the current UI, then update Marketplace copy as needed.

Learning Guides

We’re turning this repo into a learning resource alongside the extension. Planned how-to guides will live under docs/guides/ and cover:

• First haiku walkthrough: clone, install, generate, and commit with screenshots.
• Provider deep-dive: swapping Anthropic ↔ OpenAI ↔ Gemini, including rate-limit tips.
• Customization recipes: tweaking strict mode, samples, tone, and upcoming hybrid message options.

Every guide will ship with a matching issue template so contributors can add tutorials or request new ones. If you want to kick-start a guide, open an issue tagged learning, sketch the outline, and we’ll pair up on structure and screenshots.

Tips

• Stage meaningful chunks of changes for better haikus
• The AI analyzes your actual code changes to create relevant haikus
• Large diffs are automatically truncated to stay within API limits
• If the haiku doesn't fit, you can always generate a new one!

Troubleshooting

• No staged changes: Stage files first (e.g., git add -p) then rerun.
• Missing API key: Run "Haiku Commit: Set Haiku API Key" or set the provider-specific setting:
  • haikuCommit.anthropicApiKey (when provider = anthropic)
  • haikuCommit.openaiApiKey (when provider = openai)
  • haikuCommit.geminiApiKey (when provider = gemini)
• Rate limits or network errors: The extension retries transient errors with a brief backoff. If failures persist, wait a moment and try again.
• Non‑git folders: The command only works inside a git repository.
• View → Output → select "Haiku Commit" to see logs, or run "Haiku Commit: Show Logs" from the Command Palette.

Privacy & Security

• Your API key for the selected provider is stored in VS Code Settings on your machine (one of haikuCommit.anthropicApiKey, haikuCommit.openaiApiKey, or haikuCommit.geminiApiKey). It is not committed to this repository.
• The extension sends your staged git diff to the selected provider’s API (Anthropic, OpenAI, or Gemini) for haiku generation. No other data is transmitted.
• No telemetry is collected; the extension does not track usage or send analytics.
• You can remove the key at any time via Settings or by running “Haiku Commit: Set Haiku API Key” and clearing the value.

Contributing & Policies

• See CONTRIBUTING.md for setup, style, and PR guidelines.
• Read our CODE_OF_CONDUCT.md.
• Security issues? See SECURITY.md.

Contributions are welcome! Please feel free to submit a Pull Request.

Maintainers

• Adam Grenier (@akgrenier)

Support

• Bugs/feature requests → GitHub Issues
• Questions/ideas → GitHub Discussions (or Issues if Discussions aren’t enabled yet)
• Security issues → see SECURITY.md

Versioning

We follow SemVer. See CHANGELOG.md and GitHub Releases for notes. Breaking changes are called out in release notes.

Roadmap

• [x] Launch v1 with Anthropic, OpenAI, and Gemini providers
• [ ] Hybrid message mode toggle (switch between haiku then conventional subject and vice versa)
• [ ] Rich UI entry points (SCM toolbar button + activity bar view)
• [ ] Tone/style customization ("zen", "summary", "cheeky")
• [ ] VSCode "creating an extension" in-repo how-to guide series
• [ ] Partial diff QuickPick for staged-file selection
• [ ] Enhanced error UX with actionable guidance
• [ ] Multi-window status bar consistency
• [ ] PR Haiku Bot that comments poetic summaries on pull requests
• [ ] VS Code walkthrough onboarding to showcase haiku generation end-to-end

FAQ

• Q: Do I need an API key?
  • A: Yes. Set the key for the provider you choose (Anthropic, OpenAI, or Gemini). The extension prompts you if it’s missing.
• Q: Does my code get uploaded?
  • A: Only the staged git diff is sent to the selected provider to generate the haiku.
• Q: Can I switch providers?
  • A: Yes. Run “Haiku Commit: Set Haiku Provider” and choose Anthropic, OpenAI, or Gemini.
• Q: Why is a haiku sometimes labelled “approximate”?
  • A: With strict575=false, we still show whether the output truly matches 5‑7‑5; otherwise it’s labelled approximate.

Gallery

License

MIT

Credits

Built with ❤️ using:

• VS Code Extension API

Enjoy your poetic commits! 🌸📝✨