code-agent-auto-commit 1.0.0

package/docs/zh-CN.md

@@ -0,0 +1,81 @@
+# code-agent-auto-commit User Guide
+
+`code-agent-auto-commit` (`cac`) is a TypeScript-based auto-commit tool for:
+
+- OpenCode
+- Codex CLI
+- Claude Code
+
+It runs commits automatically when a chat/agent turn ends.
+
+## Quick Start
+
+```bash
+# 1. 初始化配置
+cac init
+
+# 2. 配置 AI API Key（必须，否则无法生成 AI commit message）
+#    编辑 .code-agent-auto-commit.json，设置 provider、model 和 apiKeyEnv。
+#    或者在 shell 中导出对应的环境变量：
+export MINIMAX_API_KEY='your-api-key'   # 或 OPENAI_API_KEY 等
+
+# 3. 安装钩子
+cac install --tool all --scope project
+
+# 4. 验证状态
+cac status --scope project
+```
+
+> **重要：** `cac init` 之后**必须**配置 AI provider 的 API Key。
+> 没有有效的 Key，AI 生成 commit message 会失败，`cac` 会退回到
+> `chore(auto): ...` 格式的通用消息。
+>
+> **模型选择建议：** 推荐选择速度快、轻量的模型（如 `gpt-4.1-mini`、
+> `MiniMax-M2.1-highspeed`）。Commit message 内容很短，速度比智能更重要。
+
+## Command Reference
+
+- `cac init [--worktree <path>] [--config <path>]`
+  - Initializes a config file.
+  - Writes to `<worktree>/.code-agent-auto-commit.json` by default; use `--config` for a custom path.
+
+- `cac install [--tool all|opencode|codex|claude] [--scope project|global] [--worktree <path>] [--config <path>]`
+  - Installs auto-commit adapters for selected tools (OpenCode/Codex/Claude).
+  - `--scope project` writes project-level config, `--scope global` writes user-level config.
+  - Creates the target config file automatically when it does not exist.
+
+- `cac uninstall [--tool all|opencode|codex|claude] [--scope project|global] [--worktree <path>]`
+  - Uninstalls adapters/hooks for selected tools.
+
+- `cac status [--scope project|global] [--worktree <path>] [--config <path>]`
+  - Shows active config and install status.
+  - Output includes config path, worktree, commit mode, AI/Push toggles, and adapter install status for each tool.
+
+- `cac run [--tool opencode|codex|claude|manual] [--worktree <path>] [--config <path>] [--event-json <json>] [--event-stdin]`
+  - Executes one auto-commit pass (manual trigger or hook trigger).
+  - Runs the configured pipeline: filter files -> stage -> commit -> optional push.
+
+- `cac set-worktree <path> [--config <path>]`
+  - Updates only the `worktree` field in config and leaves other settings unchanged.
+
+## Configurable Options
+
+- Commit modes:
+  - `single`: commit all files in one commit
+  - `per-file`: one commit per file
+- AI commit messages: supports `provider/model` with multiple providers (OpenAI-compatible and Anthropic-compatible)
+- Auto-push: configurable for GitHub/GitLab
+
+## Config File
+
+Default location in repository root: `.code-agent-auto-commit.json`
+
+For full field details, see `docs/CONFIG.md`.
+
+## Important Notes
+
+- `.env` and key-like files are excluded by default.
+- `per-file` mode requires a clean staging area.
+- Push is disabled by default; verify remote and branch settings before enabling.
+- `ai.providers.<name>.apiKeyEnv` must be an environment variable name (for example, `MINIMAX_API_KEY`), not the raw key.
+- If you want to store the key directly in config, use `ai.providers.<name>.apiKey`.

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "code-agent-auto-commit",
+  "version": "1.0.0",
+  "description": "CAC provides configurable AI auto-commit(using your git account) for OpenCode, Claude Code, Codex, and other AI code agents",
+  "license": "MIT",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "cac": "dist/cli.js",
+    "code-agent-auto-commit": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CONTRIBUTING.md",
+    "CODE_OF_CONDUCT.md",
+    "SECURITY.md",
+    "docs",
+    ".code-agent-auto-commit.example.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "node --test dist/test/*.test.js",
+    "prepare": "pnpm run build"
+  },
+  "keywords": [
+    "git",
+    "commit",
+    "automation",
+    "opencode",
+    "codex",
+    "claude-code"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "packageManager": "pnpm@10.28.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0xtresser/code-agent-auto-commit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/0xtresser/code-agent-auto-commit/issues"
+  },
+  "homepage": "https://github.com/0xtresser/code-agent-auto-commit#readme",
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^5.7.2"
+  }
+}