@webywz/vibe-commit 0.1.0 → 0.1.2

package/README.md

@@ -1,29 +1,77 @@
 # vibe-commit
 
-**Stylish conventional commits. Offline-first. AI-optional.**
+<p align="center">
+  <a href="https://github.com/webywz/vibe-commit/actions/workflows/ci.yml"><img src="https://github.com/webywz/vibe-commit/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+  <a href="https://www.npmjs.com/package/@webywz/vibe-commit"><img src="https://img.shields.io/npm/v/@webywz/vibe-commit.svg" alt="npm" /></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT" /></a>
+</p>
 
-Stage your files, run one command, get a commit message that looks like you meant it.
+<p align="center">
+  <strong>Stylish conventional commits. Offline-first. AI-optional.</strong><br/>
+  Stage your files, run one command, get a commit message that looks like you meant it.
+</p>
 
-一条命令，根据暂存区 diff 写出有品味的 [Conventional Commits](https://www.conventionalcommits.org/)。**无 API Key 也能用**，有 Key 时再可选 AI。
+<p align="center">
+  有品味的 Conventional Commits。离线优先，AI 可选。<br/>
+  暂存改动，一条命令，写出像你认真写过的提交信息。
+</p>
 
-[![CI](https://github.com/webywz/vibe-commit/actions/workflows/ci.yml/badge.svg)](https://github.com/webywz/vibe-commit/actions/workflows/ci.yml)
-[![npm](https://img.shields.io/npm/v/vibe-commit.svg)](https://www.npmjs.com/package/vibe-commit)
-[![license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+Companion spirit to [diff-vibe](https://github.com/webywz/diff-vibe): commits here, pull requests there.
+
+与 [diff-vibe](https://github.com/webywz/diff-vibe) 成对：这边写 commit，那边写 PR。
 
 ---
 
-## Demo
+## Install · 安装
+
+```bash
+npm i -g @webywz/vibe-commit
+npx @webywz/vibe-commit
+```
+
+Requires **Node.js 18.18+** and `git`. Package: [`@webywz/vibe-commit`](https://www.npmjs.com/package/@webywz/vibe-commit). Binary: `vibe-commit`.
+
+需要 **Node.js 18.18+** 与 `git`。包名 `@webywz/vibe-commit`，命令仍是 `vibe-commit`。
+
+---
+
+## Quick start · 快速开始
+
+```bash
+git add -p
+vibe-commit                         # propose from staged diff
+vibe-commit --vibe playful --commit # write the commit
+vibe-commit --dry-run               # print only (default; wins over --commit)
+git commit -m "$(vibe-commit --dry-run)"
+vibe-commit install                 # optional prepare-commit-msg hook
+```
+
+| Flag / command | What it does · 作用 |
+| --- | --- |
+| `--commit` | Run `git commit` with the proposed message · 用生成信息执行提交 |
+| `--dry-run` | Print only; never commit (default) · 只打印，不提交（默认） |
+| `--type <type>` | Force `feat` / `fix` / `docs` / `style` / `refactor` / `perf` / `test` / `build` / `ci` / `chore` |
+| `--scope <scope>` | Override inferred scope · 覆盖推断出的 scope |
+| `--vibe <style>` | `playful` \| `pro` \| `terse` (default: `pro`) |
+| `--no-ai` | Skip the API even if `OPENAI_API_KEY` is set · 即使有 Key 也不走 AI |
+| `--json` | Machine-readable proposal · 机器可读提案 |
+| `install [--path]` | Install the prepare-commit-msg hook · 安装钩子 |
+| `uninstall [--path]` | Remove the managed hook · 卸载钩子 |
+| `-h` / `-v` | Help / version · 帮助 / 版本 |
+
+**Vibes** · 语气
+
+- **pro** — default. Imperative, review-ready. · 默认：祈使句，可进 review。
+- **terse** — headline only, filler gone. · 只留标题，去掉废话。
+- **playful** — a little personality, still safe for a real repo. · 带一点性格，但仍适合正经仓库。
 
 ```text
-$ git add src/heuristic.ts
 $ vibe-commit
 
   vibe-commit  ·  heuristic  ·  feat
 
   1 file  ·  +124  −8
 
-    M  src/heuristic.ts  +124 −8
-
   proposed
 
     feat(heuristic): infer conventional commit type from staged diffs
@@ -31,127 +79,80 @@ $ vibe-commit
   next  vibe-commit --commit
 ```
 
-```text
-$ vibe-commit --vibe playful --commit
-    feat(cli): ship offline heuristic commit messages — quietly useful
-  committed
-```
-
-Pipe-friendly when stdout is not a TTY:
+### Git hook · 钩子
 
 ```bash
-git commit -m "$(vibe-commit --dry-run)"
+vibe-commit install
+vibe-commit install --path ~/projects/app
+vibe-commit uninstall
 ```
 
----
-
-## Install · 安装
+After install, plain `git commit` (no `-m`) fills an empty or comment-only message file with a conventional proposal.
 
-```bash
-npm install -g vibe-commit
-# or, no install:
-npx vibe-commit
-```
+安装后，裸 `git commit`（没有 `-m`）会在空 / 仅注释的提交说明里填入提案。
 
-Requires **Node.js 18.18+** and `git`.
+| Situation · 情况 | Behavior · 行为 |
+| --- | --- |
+| Source is `merge`, `squash`, or `commit` (amend) | Leave the message alone · 不改 |
+| Message already has non-comment text (e.g. `git commit -m`) | Never overwrite · 绝不覆盖 |
+| No staged changes / generator error | Exit 0 — never break the commit · 以 0 退出，不打断提交 |
 
-```bash
-npm i -g vibe-commit          # 全局安装
-npx vibe-commit               # 一次性运行
-```
+Hook stays **offline by default** (`VIBE_COMMIT_HOOK_AI=1` to allow AI). Unique markers (`# BEGIN VIBE-COMMIT` … `# END VIBE-COMMIT`) keep uninstall clean. A foreign `prepare-commit-msg` is backed up to `prepare-commit-msg.vibe-backup` and chained after ours.
 
----
+钩子默认离线；设 `VIBE_COMMIT_HOOK_AI=1` 才允许 AI。用标记块保证干净卸载。已有外来钩子会备份并链式调用。
 
-## Usage · 用法
+### AI (optional) · AI（可选）
 
 ```bash
-git add -p          # stage the work you actually want to commit
-vibe-commit         # inspect the staged diff, print a proposal
-vibe-commit --commit
+export OPENAI_API_KEY=sk-...
+export OPENAI_MODEL=gpt-4o-mini          # optional
+export OPENAI_BASE_URL=https://api.openai.com/v1
+export VIBE_COMMIT_VIBE=pro              # or VIBE
 ```
 
-| Flag | What it does · 作用 |
-| --- | --- |
-| `--commit` | Run `git commit` with the proposed message · 用生成的信息执行提交 |
-| `--dry-run` | Print only; never commit (default, and wins over `--commit`) |
-| `--type <type>` | Force `feat` / `fix` / `docs` / `style` / `refactor` / `perf` / `test` / `build` / `ci` / `chore` |
-| `--scope <scope>` | Override inferred scope · 覆盖推断出的 scope |
-| `--vibe <style>` | `playful` \| `pro` \| `terse` (default: `pro`) |
-| `--no-ai` | Skip the API even if `OPENAI_API_KEY` is set |
-| `--json` | Machine-readable proposal |
-| `-h`, `--help` | Help |
-| `-v`, `--version` | Version |
+OpenAI-compatible Chat Completions. Missing key, timeout, or 4xx/5xx → silent fallback to the offline heuristic. See [`.env.example`](.env.example). Unstaged files are never sent; huge diffs are truncated.
 
-### Vibes
+兼容 OpenAI Chat Completions。没 Key、超时或 4xx/5xx → 静默回退离线启发式。可参考 `.env.example`。不会上传未暂存文件；过大 diff 会截断。
 
-- **pro** — default. Imperative, review-ready, conventional.
-- **terse** — headline only, filler words gone.
-- **playful** — a little personality, still safe for a real repo.
+### Library · 库
 
-默认 **pro**：专业、祈使句、可直接进 code review。`terse` 更短；`playful` 带一点俏皮，但不会变成段子。
+```ts
+import { proposeHeuristic, formatCommit } from "@webywz/vibe-commit";
+
+const message = proposeHeuristic({ diff, vibe: "pro" });
+console.log(formatCommit(message));
+// feat(auth): add login
+```
 
 ---
 
-## How it works · 原理
+## Features · 特性
 
-1. Read **staged** changes only (`git diff --cached`). Unstaged noise is ignored.
-2. **Offline heuristic** (always on): file paths + hunk keywords + added identifiers → `type`, `scope`, `subject`.
+1. Reads **staged** changes only (`git diff --cached`). Unstaged noise is ignored.
+   只读 **已暂存** 改动；忽略未暂存噪音。
+2. **Offline heuristic** always on: paths + hunk keywords + added identifiers → `type`, `scope`, `subject`.
+   **离线启发式**始终开启：路径 + hunk 关键词 + 新增标识 → `type` / `scope` / `subject`。
    - `README` / `docs/` → `docs`
    - `*.test.ts` / `test/` → `test`
    - `.github/workflows` → `ci`
    - lockfiles / `package.json` → `chore`
    - `fix` / `bug` / `crash` in the diff → `fix`
    - new files / `export function` → `feat`
-3. If `OPENAI_API_KEY` is set, ask an OpenAI-compatible model and **fall back to the heuristic** on any failure.
-4. Print a proposal. With `--commit`, run `git commit` (headline + optional body as two `-m` flags — no shell interpolation).
-
-只看 **已暂存** 的 diff。启发式始终可用；配置了 API Key 才走模型，失败自动回退。
-
----
-
-## AI (optional)
-
-```bash
-export OPENAI_API_KEY=sk-...
-# optional:
-export OPENAI_MODEL=gpt-4o-mini
-export OPENAI_BASE_URL=https://api.openai.com/v1   # any compatible gateway
-export VIBE_COMMIT_VIBE=pro
-```
-
-Copy `.env.example` if you keep secrets in a file. vibe-commit never sends unstaged files, and it truncates huge diffs.
-
-兼容 OpenAI Chat Completions。没 Key、超时、4xx/5xx → 静默回退到离线启发式，CLI 仍然能给出一条能用的信息。
+3. Optional AI draft with automatic heuristic fallback.
+   可选 AI 草稿，失败自动回退启发式。
+4. Managed `prepare-commit-msg` hook via `install` / `uninstall`.
+   通过 `install` / `uninstall` 管理 `prepare-commit-msg` 钩子。
 
 ---
 
-## Library
+## Links · 链接
 
-```ts
-import { proposeHeuristic, formatCommit } from "vibe-commit";
-
-const message = proposeHeuristic({ diff, vibe: "pro" });
-console.log(formatCommit(message));
-// feat(auth): add login
-```
-
----
-
-## Develop · 开发
+- npm · [`@webywz/vibe-commit`](https://www.npmjs.com/package/@webywz/vibe-commit)
+- Source · [github.com/webywz/vibe-commit](https://github.com/webywz/vibe-commit)
+- Related · [diff-vibe](https://github.com/webywz/diff-vibe) · [prompt-diff](https://github.com/webywz/prompt-diff)
+- License · [MIT](./LICENSE)
 
 ```bash
-git clone https://github.com/webywz/vibe-commit
-cd vibe-commit
-npm install
-npm test
-npm run build
+npm install && npm test && npm run build
 node dist/cli.js --help
 ```
-
-| Script |  |
-| --- | --- |
-| `npm test` | Unit + e2e tests (`node:test` + `tsx`) |
-| `npm run build` | Emit `dist/` |
-| `npm run typecheck` | `tsc --noEmit` |
-
-MIT © webywz — see [LICENSE](./LICENSE).

package/dist/cli.js

@@ -1,10 +1,11 @@
 #!/usr/bin/env node
 import { readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
+import { dirname, join, resolve } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import pc from "picocolors";
 import { formatCommit } from "./format.js";
 import { commitWithMessage, GitError, inspectStaged } from "./git.js";
+import { installHook, uninstallHook, runPrepareCommitMsg } from "./hook.js";
 import { helpText, parseArgs, UsageError } from "./parse-args.js";
 import { proposeMessage } from "./propose.js";
 import { renderError, renderProposal, renderVersion } from "./render.js";
@@ -28,6 +29,15 @@ export async function main(argv = process.argv.slice(2)) {
         process.stdout.write(`${renderVersion(readVersion())}\n`);
         return 0;
     }
+    if (options.command === "install") {
+        return runInstall(options.path);
+    }
+    if (options.command === "uninstall") {
+        return runUninstall(options.path);
+    }
+    if (options.command === "prepare-commit-msg") {
+        return runHookPrepare(options.messageFile, options.commitSource);
+    }
     const piped = !process.stdout.isTTY;
     try {
         const diff = inspectStaged();
@@ -64,6 +74,64 @@ export async function main(argv = process.argv.slice(2)) {
         return 1;
     }
 }
+function runInstall(repoPath) {
+    try {
+        const target = resolve(repoPath ?? process.cwd());
+        const result = installHook(target);
+        const action = result.updated
+            ? "updated"
+            : result.created
+                ? "installed"
+                : "installed";
+        process.stdout.write(`${pc.green("ok")}  prepare-commit-msg hook ${action}\n` +
+            `     ${result.hookPath}\n`);
+        if (result.backedUp) {
+            process.stdout.write(`     previous hook backed up as prepare-commit-msg.vibe-backup\n`);
+        }
+        process.stdout.write(`     tip: plain \`git commit\` (no -m) will fill an empty message\n`);
+        return 0;
+    }
+    catch (error) {
+        const text = error instanceof GitError || error instanceof Error
+            ? error.message
+            : "Unexpected error";
+        process.stderr.write(`${renderError(text)}\n`);
+        return 1;
+    }
+}
+function runUninstall(repoPath) {
+    try {
+        const target = resolve(repoPath ?? process.cwd());
+        const result = uninstallHook(target);
+        if (!result.removed) {
+            process.stdout.write(`${pc.yellow("skip")}  no managed vibe-commit hook found\n` +
+                `      ${result.hookPath}\n`);
+            return 0;
+        }
+        process.stdout.write(`${pc.green("ok")}  prepare-commit-msg hook removed\n` +
+            `     ${result.hookPath}\n`);
+        if (result.restored) {
+            process.stdout.write(`     previous hook restored from backup\n`);
+        }
+        return 0;
+    }
+    catch (error) {
+        const text = error instanceof GitError || error instanceof Error
+            ? error.message
+            : "Unexpected error";
+        process.stderr.write(`${renderError(text)}\n`);
+        return 1;
+    }
+}
+async function runHookPrepare(messageFile, commitSource) {
+    try {
+        await runPrepareCommitMsg(messageFile, commitSource, process.cwd());
+    }
+    catch {
+        // Never fail a commit because the hook misfired.
+    }
+    return 0;
+}
 function readVersion() {
     try {
         const here = dirname(fileURLToPath(import.meta.url));

package/dist/hook.d.ts

@@ -0,0 +1,42 @@
+export declare const HOOK_BEGIN = "# BEGIN VIBE-COMMIT";
+export declare const HOOK_END = "# END VIBE-COMMIT";
+export declare const HOOK_NAME = "prepare-commit-msg";
+export declare const HOOK_BACKUP_NAME = "prepare-commit-msg.vibe-backup";
+export declare function hasNonCommentContent(content: string): boolean;
+/** Skip merge/squash/amend, or when the message file already has user text. */
+export declare function shouldSkipPrepareCommitMsg(messageFileContent: string, source?: string): boolean;
+/**
+ * prepare-commit-msg runner. Offline by default (set VIBE_COMMIT_HOOK_AI=1 to enable AI).
+ * Never throws into git — failures are swallowed as "noop".
+ */
+export declare function runPrepareCommitMsg(messageFile: string, source?: string, cwd?: string, env?: NodeJS.ProcessEnv): Promise<"wrote" | "skipped" | "noop">;
+export interface HookPaths {
+    repoPath: string;
+    hooksDir: string;
+    hookPath: string;
+    backupPath: string;
+}
+export declare function resolveHookPaths(repoPath?: string): HookPaths;
+export declare function resolveGitHooksDir(repoPath: string): string;
+export declare function resolveInstallCommand(argv1?: string | undefined, execPath?: string): {
+    execPath: string;
+    cliPath: string;
+};
+export declare function buildManagedHookBlock(execPath: string, cliPath: string): string;
+export declare function shellQuote(value: string): string;
+export declare function replaceManagedBlock(source: string, block: string): string;
+export declare function stripManagedBlock(source: string): string;
+export declare function installHook(repoPath?: string, command?: {
+    execPath: string;
+    cliPath: string;
+}): {
+    hookPath: string;
+    created: boolean;
+    updated: boolean;
+    backedUp: boolean;
+};
+export declare function uninstallHook(repoPath?: string): {
+    hookPath: string;
+    removed: boolean;
+    restored: boolean;
+};

package/dist/hook.js

@@ -0,0 +1,235 @@
+import { execFileSync } from "node:child_process";
+import { chmodSync, existsSync, mkdirSync, readFileSync, renameSync, unlinkSync, writeFileSync, } from "node:fs";
+import { dirname, isAbsolute, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { formatCommit } from "./format.js";
+import { assertRepo, GitError, inspectStaged } from "./git.js";
+import { defaultVibeFromEnv } from "./parse-args.js";
+import { proposeMessage } from "./propose.js";
+export const HOOK_BEGIN = "# BEGIN VIBE-COMMIT";
+export const HOOK_END = "# END VIBE-COMMIT";
+export const HOOK_NAME = "prepare-commit-msg";
+export const HOOK_BACKUP_NAME = "prepare-commit-msg.vibe-backup";
+const SKIP_SOURCES = new Set(["merge", "squash", "commit"]);
+export function hasNonCommentContent(content) {
+    return content.split(/\r?\n/).some((line) => {
+        const trimmed = line.trim();
+        return trimmed.length > 0 && !trimmed.startsWith("#");
+    });
+}
+/** Skip merge/squash/amend, or when the message file already has user text. */
+export function shouldSkipPrepareCommitMsg(messageFileContent, source) {
+    const src = (source ?? "").trim().toLowerCase();
+    if (SKIP_SOURCES.has(src))
+        return true;
+    return hasNonCommentContent(messageFileContent);
+}
+/**
+ * prepare-commit-msg runner. Offline by default (set VIBE_COMMIT_HOOK_AI=1 to enable AI).
+ * Never throws into git — failures are swallowed as "noop".
+ */
+export async function runPrepareCommitMsg(messageFile, source, cwd = process.cwd(), env = process.env) {
+    let content = "";
+    try {
+        content = readFileSync(messageFile, "utf8");
+    }
+    catch {
+        return "noop";
+    }
+    if (shouldSkipPrepareCommitMsg(content, source))
+        return "skipped";
+    try {
+        const diff = inspectStaged(cwd);
+        // Avoid hanging `git commit` on network — hooks stay offline unless opted in.
+        const useAi = env.VIBE_COMMIT_HOOK_AI === "1";
+        const message = await proposeMessage(diff, {
+            vibe: defaultVibeFromEnv(env),
+            preferAi: useAi,
+        }, env);
+        const formatted = formatCommit(message);
+        const comments = content
+            .split(/\r?\n/)
+            .filter((line) => line.trim().startsWith("#"))
+            .join("\n");
+        const next = comments
+            ? `${formatted}\n\n${comments}\n`
+            : `${formatted}\n`;
+        writeFileSync(messageFile, next, "utf8");
+        return "wrote";
+    }
+    catch {
+        return "noop";
+    }
+}
+export function resolveHookPaths(repoPath = process.cwd()) {
+    assertRepo(repoPath);
+    const hooksDir = resolveGitHooksDir(repoPath);
+    return {
+        repoPath,
+        hooksDir,
+        hookPath: join(hooksDir, HOOK_NAME),
+        backupPath: join(hooksDir, HOOK_BACKUP_NAME),
+    };
+}
+export function resolveGitHooksDir(repoPath) {
+    try {
+        const hooksPath = execFileSync("git", ["rev-parse", "--git-path", "hooks"], {
+            cwd: repoPath,
+            encoding: "utf8",
+            stdio: ["ignore", "pipe", "pipe"],
+        }).trim();
+        return isAbsolute(hooksPath) ? hooksPath : join(repoPath, hooksPath);
+    }
+    catch {
+        throw new GitError("Could not resolve .git/hooks for this repository.");
+    }
+}
+export function resolveInstallCommand(argv1 = process.argv[1], execPath = process.execPath) {
+    let cliPath;
+    if (argv1 && existsSync(argv1)) {
+        cliPath = argv1;
+    }
+    else {
+        const here = dirname(fileURLToPath(import.meta.url));
+        for (const name of ["cli.js", "cli.ts"]) {
+            const candidate = join(here, name);
+            if (existsSync(candidate)) {
+                cliPath = candidate;
+                break;
+            }
+        }
+    }
+    if (!cliPath) {
+        throw new GitError("Could not locate the vibe-commit CLI entry. Reinstall @webywz/vibe-commit and retry.");
+    }
+    // Source installs (tsx) need the tsx binary; published dist uses node + cli.js.
+    if (cliPath.endsWith(".ts")) {
+        const tsx = findTsxBinary(cliPath);
+        if (tsx)
+            return { execPath: tsx, cliPath };
+    }
+    return { execPath, cliPath };
+}
+function findTsxBinary(cliPath) {
+    let dir = dirname(cliPath);
+    for (let i = 0; i < 6; i += 1) {
+        const bin = join(dir, "node_modules", ".bin", "tsx");
+        if (existsSync(bin))
+            return bin;
+        const parent = dirname(dir);
+        if (parent === dir)
+            break;
+        dir = parent;
+    }
+    return undefined;
+}
+export function buildManagedHookBlock(execPath, cliPath) {
+    const node = shellQuote(execPath);
+    const cli = shellQuote(cliPath);
+    return [
+        HOOK_BEGIN,
+        "# Managed by @webywz/vibe-commit — do not edit this block",
+        `${node} ${cli} prepare-commit-msg "$1" "$2" || true`,
+        HOOK_END,
+    ].join("\n");
+}
+export function shellQuote(value) {
+    return `'${value.replace(/'/g, `'\\''`)}'`;
+}
+export function replaceManagedBlock(source, block) {
+    const begin = source.indexOf(HOOK_BEGIN);
+    const end = source.indexOf(HOOK_END);
+    if (begin === -1 || end === -1 || end < begin) {
+        return `${source.trimEnd()}\n\n${block}\n`;
+    }
+    const afterEnd = end + HOOK_END.length;
+    return `${source.slice(0, begin)}${block}${source.slice(afterEnd)}`;
+}
+export function stripManagedBlock(source) {
+    const begin = source.indexOf(HOOK_BEGIN);
+    const end = source.indexOf(HOOK_END);
+    if (begin === -1 || end === -1 || end < begin)
+        return source;
+    const afterEnd = end + HOOK_END.length;
+    const before = source.slice(0, begin).replace(/\n+$/, "\n");
+    const after = source.slice(afterEnd).replace(/^\n+/, "\n");
+    return `${before}${after}`.replace(/\n{3,}/g, "\n\n").trimStart();
+}
+function ensureTrailingNewline(text) {
+    return text.endsWith("\n") ? text : `${text}\n`;
+}
+function isShebangOnly(text) {
+    const trimmed = text.trim();
+    return (trimmed === "" ||
+        trimmed === "#!/bin/sh" ||
+        trimmed === "#!/usr/bin/env bash" ||
+        trimmed === "#!/bin/bash");
+}
+export function installHook(repoPath = process.cwd(), command = resolveInstallCommand()) {
+    const paths = resolveHookPaths(repoPath);
+    mkdirSync(paths.hooksDir, { recursive: true });
+    const block = buildManagedHookBlock(command.execPath, command.cliPath);
+    const existing = existsSync(paths.hookPath)
+        ? readFileSync(paths.hookPath, "utf8")
+        : null;
+    let backedUp = false;
+    let created = false;
+    let updated = false;
+    if (existing === null) {
+        writeFileSync(paths.hookPath, `#!/bin/sh\n${block}\n`, { mode: 0o755 });
+        created = true;
+    }
+    else if (existing.includes(HOOK_BEGIN) && existing.includes(HOOK_END)) {
+        const next = replaceManagedBlock(existing, block);
+        writeFileSync(paths.hookPath, ensureTrailingNewline(next), {
+            mode: 0o755,
+        });
+        updated = true;
+    }
+    else {
+        // Foreign hook: back it up, install wrapper that runs us then chains.
+        writeFileSync(paths.backupPath, existing, { mode: 0o755 });
+        chmodSync(paths.backupPath, 0o755);
+        backedUp = true;
+        const wrapper = [
+            "#!/bin/sh",
+            block,
+            "",
+            "# Chain the previous prepare-commit-msg hook",
+            `if [ -x ${shellQuote(paths.backupPath)} ]; then`,
+            `  ${shellQuote(paths.backupPath)} "$@" || exit $?`,
+            "fi",
+            "",
+        ].join("\n");
+        writeFileSync(paths.hookPath, wrapper, { mode: 0o755 });
+        created = true;
+    }
+    chmodSync(paths.hookPath, 0o755);
+    return { hookPath: paths.hookPath, created, updated, backedUp };
+}
+export function uninstallHook(repoPath = process.cwd()) {
+    const paths = resolveHookPaths(repoPath);
+    if (!existsSync(paths.hookPath)) {
+        return { hookPath: paths.hookPath, removed: false, restored: false };
+    }
+    const existing = readFileSync(paths.hookPath, "utf8");
+    const hasManaged = existing.includes(HOOK_BEGIN) && existing.includes(HOOK_END);
+    if (!hasManaged) {
+        return { hookPath: paths.hookPath, removed: false, restored: false };
+    }
+    if (existsSync(paths.backupPath)) {
+        renameSync(paths.backupPath, paths.hookPath);
+        chmodSync(paths.hookPath, 0o755);
+        return { hookPath: paths.hookPath, removed: true, restored: true };
+    }
+    const stripped = stripManagedBlock(existing).trim();
+    if (isShebangOnly(stripped)) {
+        unlinkSync(paths.hookPath);
+        return { hookPath: paths.hookPath, removed: true, restored: false };
+    }
+    writeFileSync(paths.hookPath, ensureTrailingNewline(stripped), {
+        mode: 0o755,
+    });
+    return { hookPath: paths.hookPath, removed: true, restored: false };
+}
+//# sourceMappingURL=hook.js.map

package/dist/index.d.ts

@@ -4,7 +4,8 @@ export { inspectStaged, commitWithMessage, GitError } from "./git.ts";
 export { proposeHeuristic, inferType, inferScope, inferSubject, classifyPath, } from "./heuristic.ts";
 export { parseArgs, helpText, UsageError } from "./parse-args.ts";
 export { assembleDiff, parseUnifiedDiff } from "./parse-diff.ts";
+export { installHook, uninstallHook, runPrepareCommitMsg, shouldSkipPrepareCommitMsg, hasNonCommentContent, HOOK_BEGIN, HOOK_END, } from "./hook.ts";
 export { proposeMessage } from "./propose.ts";
 export { applyVibe } from "./vibe.ts";
-export type { CliOptions, CommitType, ProposedMessage, ProposeOptions, StagedDiff, StagedFile, Vibe, } from "./types.ts";
+export type { CliCommand, CliOptions, CommitType, ProposedMessage, ProposeOptions, StagedDiff, StagedFile, Vibe, } from "./types.ts";
 export { COMMIT_TYPES, VIBES } from "./types.ts";

package/dist/index.js

@@ -4,6 +4,7 @@ export { inspectStaged, commitWithMessage, GitError } from "./git.js";
 export { proposeHeuristic, inferType, inferScope, inferSubject, classifyPath, } from "./heuristic.js";
 export { parseArgs, helpText, UsageError } from "./parse-args.js";
 export { assembleDiff, parseUnifiedDiff } from "./parse-diff.js";
+export { installHook, uninstallHook, runPrepareCommitMsg, shouldSkipPrepareCommitMsg, hasNonCommentContent, HOOK_BEGIN, HOOK_END, } from "./hook.js";
 export { proposeMessage } from "./propose.js";
 export { applyVibe } from "./vibe.js";
 export { COMMIT_TYPES, VIBES } from "./types.js";

package/dist/parse-args.js

@@ -3,6 +3,12 @@ const HELP = `vibe-commit — stylish conventional commits, offline-first
 
 Usage
   vibe-commit [options]
+  vibe-commit install [--path <repo>]
+  vibe-commit uninstall [--path <repo>]
+
+Commands
+  install             Install a prepare-commit-msg hook in the repo
+  uninstall           Remove the managed prepare-commit-msg hook
 
 Options
   --commit            Create the commit with the proposed message
@@ -12,6 +18,7 @@ Options
   --vibe <style>      playful | pro | terse          (default: pro)
   --no-ai             Skip AI even if OPENAI_API_KEY is set
   --json              Print a machine-readable proposal
+  --path <repo>       Repo root for install/uninstall (default: cwd)
   -h, --help          Show help
   -v, --version       Show version
 
@@ -20,12 +27,20 @@ Env
   OPENAI_MODEL        Default: gpt-4o-mini
   OPENAI_BASE_URL     Default: https://api.openai.com/v1
   VIBE / VIBE_COMMIT_VIBE   Default vibe when --vibe is omitted
+  VIBE_COMMIT_HOOK_AI Set to 1 to allow AI inside the git hook (off by default)
+
+Git hook
+  After \`vibe-commit install\`, plain \`git commit\` (no -m) fills an empty /
+  comment-only message file with a vibe-commit proposal. Skips merge, squash,
+  amend (source=commit), and any message that already has non-comment text.
 
 Examples
   git add -p
   vibe-commit
   vibe-commit --vibe playful --commit
   git commit -m "$(vibe-commit --dry-run)"
+  vibe-commit install
+  vibe-commit uninstall --path ~/projects/app
 `;
 export function defaultVibeFromEnv(env = process.env) {
     const raw = (env.VIBE_COMMIT_VIBE ?? env.VIBE ?? "pro").trim().toLowerCase();
@@ -33,6 +48,7 @@ export function defaultVibeFromEnv(env = process.env) {
 }
 export function parseArgs(argv, env = process.env) {
     const options = {
+        command: "propose",
         commit: false,
         dryRun: false,
         vibe: defaultVibeFromEnv(env),
@@ -41,7 +57,15 @@ export function parseArgs(argv, env = process.env) {
         help: false,
         version: false,
     };
-    for (let i = 0; i < argv.length; i += 1) {
+    let i = 0;
+    if (argv[0] && !argv[0].startsWith("-")) {
+        const cmd = parseCommand(argv[0]);
+        if (cmd) {
+            options.command = cmd;
+            i = 1;
+        }
+    }
+    for (; i < argv.length; i += 1) {
         const arg = argv[i];
         if (arg === undefined)
             break;
@@ -86,13 +110,49 @@ export function parseArgs(argv, env = process.env) {
             options.vibe = parseVibe(value);
             continue;
         }
+        if (arg === "--path" || arg.startsWith("--path=")) {
+            const value = arg.includes("=") ? arg.slice("--path=".length) : argv[++i];
+            if (!value)
+                throw new UsageError("Missing value for --path");
+            options.path = value;
+            continue;
+        }
         if (arg.startsWith("-")) {
             throw new UsageError(`Unknown option: ${arg}`);
         }
+        if (options.command === "prepare-commit-msg") {
+            if (!options.messageFile) {
+                options.messageFile = arg;
+                continue;
+            }
+            if (!options.commitSource) {
+                options.commitSource = arg;
+                continue;
+            }
+            throw new UsageError(`Unexpected argument: ${arg}`);
+        }
         throw new UsageError(`Unexpected argument: ${arg}`);
     }
+    if (options.command === "prepare-commit-msg" && !options.messageFile) {
+        throw new UsageError("prepare-commit-msg requires a message file path (git passes this automatically)");
+    }
+    if (options.path &&
+        options.command !== "install" &&
+        options.command !== "uninstall") {
+        throw new UsageError("--path is only valid with install or uninstall");
+    }
     return options;
 }
+function parseCommand(value) {
+    switch (value) {
+        case "install":
+        case "uninstall":
+        case "prepare-commit-msg":
+            return value;
+        default:
+            return null;
+    }
+}
 export function parseType(value) {
     const raw = value?.trim().toLowerCase();
     if (!raw)

package/dist/types.d.ts

@@ -35,7 +35,9 @@ export interface ProposeOptions {
     vibe: Vibe;
     preferAi?: boolean;
 }
+export type CliCommand = "propose" | "install" | "uninstall" | "prepare-commit-msg";
 export interface CliOptions {
+    command: CliCommand;
     commit: boolean;
     dryRun: boolean;
     type?: CommitType;
@@ -45,4 +47,10 @@ export interface CliOptions {
     json: boolean;
     help: boolean;
     version: boolean;
+    /** Target repo for install/uninstall (default: cwd). */
+    path?: string;
+    /** Message file path for prepare-commit-msg. */
+    messageFile?: string;
+    /** Git prepare-commit-msg source (message|template|merge|squash|commit). */
+    commitSource?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webywz/vibe-commit",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Stylish conventional commit messages with personality. Offline-first, AI-optional.",
   "keywords": [
     "git",
@@ -23,7 +23,10 @@
   "author": "webywz",
   "type": "module",
   "bin": {
-    "vibe-commit": "./dist/cli.js"
+    "vibe-commit": "dist/cli.js"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "exports": {
     ".": {
@@ -43,7 +46,7 @@
     "node": ">=18.18"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && node -e \"require('fs').chmodSync('dist/cli.js', 0o755)\"",
     "clean": "rm -rf dist",
     "prepublishOnly": "npm run build",
     "test": "tsx --test test/*.test.ts",