chore(cli): Update CLI commands and environment configuration

This commit modifies the command-line interface for the AI-assisted
conventional commit tool. The primary change is the renaming of the
command from `commit-ai` to `ai-commit`, which enhances clarity and
consistency across the tool's usage.

Additionally, the environment configuration file has been updated to
include new provider options and model settings. This change allows
users to customize their AI provider and model more effectively,
improving the overall flexibility of the tool.

These updates aim to streamline user experience and provide clearer
guidance on configuration options.

Author: verndalerenangarcia

.env-example

@@ -1,9 +1,28 @@
 # ------------------------------------------------------------
 # @verndale/ai-commit (pnpm commit / ai-commit run)
 # ------------------------------------------------------------
+
+# --- Provider configuration ---
+# COMMIT_AI_PROVIDER=openai          # openai (default), anthropic, ollama, azure-openai
+# COMMIT_AI_MODEL=gpt-4o-mini        # Model override (default depends on provider)
+# COMMIT_AI_API_KEY=                  # Universal API key (or use provider-specific below)
+# COMMIT_AI_BASE_URL=                 # Custom API base URL
+
+# --- OpenAI (default provider) ---
 # @verndale/ai-commit — OPENAI_API_KEY: OpenAI API key for conventional commit messages (ai-commit run; optional for prepare-commit-msg with AI).
 OPENAI_API_KEY=
 
-# Optional — default is gpt-4o-mini
-# COMMIT_AI_MODEL=
+# --- Anthropic ---
+# ANTHROPIC_API_KEY=
+
+# --- Azure OpenAI ---
+# AZURE_OPENAI_API_KEY=
+# AZURE_OPENAI_ENDPOINT=https://<resource>.openai.azure.com
+# AZURE_OPENAI_DEPLOYMENT=
+# AZURE_OPENAI_API_VERSION=2024-08-01-preview
+
+# --- Ollama (local, no API key needed) ---
+# COMMIT_AI_PROVIDER=ollama
+# COMMIT_AI_BASE_URL=http://localhost:11434
+# COMMIT_AI_MODEL=llama3.2
 

bin/cli.js

@@ -41,23 +41,23 @@ function commitlintCliPath() {
 }
 
 function printHelp() {
-  process.stdout.write(`${bold("commit-ai")} — AI-assisted conventional commits with bundled commitlint
+  process.stdout.write(`${bold("ai-commit")} — AI-assisted conventional commits with bundled commitlint
 
 ${bold("Usage:")}
-  commit-ai run [options]
-  commit-ai init [--force] [--env-only] [--husky] [--workspace]
-  commit-ai prepare-commit-msg <file> [source]
-  commit-ai lint --edit <file>
-  commit-ai config [--init]
-  commit-ai hooks install
+  ai-commit run [options]
+  ai-commit init [--force] [--env-only] [--husky] [--workspace]
+  ai-commit prepare-commit-msg <file> [source]
+  ai-commit lint --edit <file>
+  ai-commit config [--init]
+  ai-commit hooks install
 
 ${bold("Commands:")}
   ${green("run")}                  Generate a message from the staged diff and run git commit.
   ${green("init")}                 Merge env, then Husky + package.json + hooks. Use --env-only, --husky, --workspace, --force.
   ${green("prepare-commit-msg")}   Git hook: fill an empty commit message file.
   ${green("lint")}                 Run commitlint with the bundled config (for commit-msg hook).
   ${green("config")}               Show resolved configuration (or --init to create config file).
-  ${green("hooks")}                Install git hooks (commit-ai hooks install).
+  ${green("hooks")}                Install git hooks (ai-commit hooks install).
 
 ${bold("Run Options:")}
   --dry-run            Generate and display the message without committing.
@@ -311,7 +311,7 @@ function stripGitComments(text) {
 async function cmdRun(flags) {
   assertInGitRepo();
   if (!hasStagedChanges()) {
-    fail("No staged changes. Stage files before running commit-ai.");
+    fail("No staged changes. Stage files before running ai-commit.");
     process.exit(1);
   }
 
@@ -399,7 +399,7 @@ function cmdLint(editFile) {
 
 function cmdConfig(argv) {
   if (argv.includes("--init")) {
-    const configPath = path.join(process.cwd(), ".commit-airc.json");
+    const configPath = path.join(process.cwd(), ".ai-commitrc.json");
     if (fs.existsSync(configPath)) {
       info(`Config file already exists: ${configPath}`);
       return;
@@ -451,8 +451,8 @@ function cmdHooksInstall() {
   const huskyDir = path.join(cwd, ".husky");
   const gitHooksDir = path.join(cwd, ".git", "hooks");
 
-  const prepareCommitMsg = 'commit-ai prepare-commit-msg "$1" "$2"\n';
-  const commitMsg = 'commit-ai lint --edit "$1"\n';
+  const prepareCommitMsg = 'ai-commit prepare-commit-msg "$1" "$2"\n';
+  const commitMsg = 'ai-commit lint --edit "$1"\n';
 
   if (fs.existsSync(huskyDir)) {
     const prepareFile = path.join(huskyDir, "prepare-commit-msg");
@@ -524,9 +524,9 @@ async function main() {
       cmdHooksInstall();
       return;
     }
-    throw new Error("Usage: commit-ai hooks install");
+    throw new Error("Usage: ai-commit hooks install");
   }
-  throw new Error(`Unknown command: ${cmd}. Run commit-ai --help for usage.`);
+  throw new Error(`Unknown command: ${cmd}. Run ai-commit --help for usage.`);
 }
 
 main().catch((e) => {