gitxplain 0.1.0 → 0.1.3

package/cli/index.js

@@ -5,15 +5,43 @@ import process from "node:process";
 import { fileURLToPath } from "node:url";
 import { realpathSync } from "node:fs";
 import { generateExplanation } from "./services/aiService.js";
+import { startChatSession } from "./services/chatService.js";
+import { loadEnvFile } from "./services/envLoader.js";
+import {
+  saveGitConnection,
+  isGitConnected,
+  loadGitConnection,
+  getGitUserInfo,
+  verifyGitToken
+} from "./services/gitConnectionService.js";
 import { copyToClipboard } from "./services/clipboardService.js";
 import { loadConfig } from "./services/configService.js";
 import {
   buildBranchRange,
+  deletePaths,
   fetchCommitData,
+  fetchWorkingTreeData,
+  gitAddFiles,
+  gitPush,
+  gitStashPop,
+  gitRestoreStaged,
+  getRepositoryLog,
+  getRepositoryStatus,
   getDefaultBaseRef,
-  isGitRepository
+  isGitRepository,
+  resolveStashRef
 } from "./services/gitService.js";
 import { installHook } from "./services/hookService.js";
+import {
+  buildReleaseMergePlan,
+  buildReleaseTagPlan,
+  executeReleaseMerge,
+  executeReleaseTagPlan,
+  finalizeReleaseMergePlan,
+  finalizeReleaseTagPlan,
+  formatReleaseMergePlan,
+  formatReleaseTagPlan
+} from "./services/mergeService.js";
 import {
   formatFooter,
   formatHtmlOutput,
@@ -22,6 +50,14 @@ import {
   formatOutput,
   formatPreamble
 } from "./services/outputFormatter.js";
+import { executeCommitPlan, formatCommitPlan, parseCommitPlan, reconcileCommitPlan } from "./services/commitService.js";
+import {
+  executeSplit,
+  formatSplitPlan,
+  parseSplitPlan,
+  reconcileSplitPlan,
+  validateSplitExecutionTarget
+} from "./services/splitService.js";
 
 const MODE_FLAGS = new Map([
   ["--summary", "summary"],
@@ -31,7 +67,13 @@ const MODE_FLAGS = new Map([
   ["--full", "full"],
   ["--lines", "lines"],
   ["--review", "review"],
-  ["--security", "security"]
+  ["--security", "security"],
+  ["--split", "split"],
+  ["--merge", "merge"],
+  ["--tag", "tag"],
+  ["--commit", "commit"],
+  ["--log", "log"],
+  ["--status", "status"]
 ]);
 
 const FORMAT_FLAGS = new Map([
@@ -41,35 +83,78 @@ const FORMAT_FLAGS = new Map([
 ]);
 
 function printHelp() {
-  console.log(`gitxplain - AI-powered Git and branch explainer
+  console.log(`gitxplain - AI-powered Git change analysis, review, and commit workflow CLI
 
 Usage:
   gitxplain help
   gitxplain --help
+  gitxplain commit
+  gitxplain --commit
+  gitxplain merge
+  gitxplain --merge
+  gitxplain tag
+  gitxplain --tag
+  gitxplain log
+  gitxplain --log
+  gitxplain status
+  gitxplain --status
+  gitxplain add <path> [more-paths...]
+  gitxplain remove <path> [more-paths...]
+  gitxplain del <path> [more-paths...]
+  gitxplain pop [stash-index]
+  gitxplain push [remote] [branch]
   gitxplain install-hook [hook-name]
+  gitxplain --connect-git [token]
+  gitxplain --boot [options]
   gitxplain <commit-id> [options]
   gitxplain <start>..<end> [options]
   gitxplain --branch [base-ref] [options]
   gitxplain --pr [base-ref] [options]
 
+What It Does:
+  Analyze commits, ranges, branches, and working tree changes
+  Generate summaries, reviews, security checks, and line-by-line walkthroughs
+  Plan commits for uncommitted work and split oversized commits into atomic steps
+  Merge release-version branch changes into a dedicated release branch
+  Tag release-version commit windows on the current branch
+  Inspect repository history and working tree status without calling the LLM
+  Run quick local actions to stage, unstage, delete files, pop stashes, or push
+
 Modes:
-  --summary    Generate a one-line summary
-  --issues     Focus on bug or issue analysis
-  --fix        Explain the fix in simple terms
+  --summary    Generate a one-line summary of a change
+  --issues     Focus on the bug, issue, or failure being addressed
+  --fix        Explain the fix in simple, junior-friendly terms
   --impact     Explain before-vs-after behavior changes
   --full       Generate a full structured analysis
-  --lines      Explain the changed code line by line
-  --review     Generate a code review with risks and suggestions
-  --security   Focus on security risks introduced by the change
+  --lines      Walk through the changed code file by file
+  --review     Generate review findings, risks, and suggestions
+  --security   Focus on security-relevant changes and concerns
+  --split      Propose splitting a commit into smaller atomic commits
+  --merge      Preview or apply a merge into the release branch based on version bumps
+  --tag        Preview or create release tags based on version bumps
+  --commit     Propose commits for current uncommitted changes
+  --log        Print Git log entries for the current repository
+  --status     Print Git working tree status for the current repository
+  --execute    Execute a proposed split or commit plan
+  --dry-run    Preview the plan without executing it (default for --split and --commit)
+
+Quick Actions:
+  add         Stage one or more files with git add
+  remove      Unstage one or more files with git restore --staged
+  del         Delete one or more files from the working tree
+  pop         Pop a stash entry with a plain numeric index like "pop 2"
+  push        Run git push, optionally with a remote and branch
 
 Output:
-  --json       Print JSON output
+  --json       Print structured JSON output
   --markdown   Print Markdown output
   --html       Print HTML output
-  --quiet      Print only the explanation body
+  --quiet      Print only the main body without extra framing
   --verbose    Print provider, model, cache, latency, and usage details
   --clipboard  Copy the final output to the system clipboard
-  --stream     Stream the explanation as it is generated when supported
+  --stream     Stream model output as it is generated when supported
+  --boot       Launch an interactive chat session for dynamic querying, PR creation, and cloning.
+  --connect-git Save your GitHub Personal Access Token to act autonomously inside Chat.
 
 Providers:
   --provider   LLM provider: openai, groq, openrouter, gemini, ollama, chutes
@@ -79,14 +164,34 @@ Diff Budget:
   --max-diff-lines <n>   Limit diff lines sent to the model
 
 Comparison:
-  --branch [base-ref]    Analyze current branch against base branch
-  --pr [base-ref]        Alias for --branch, useful for PR-style summaries
+  --branch [base-ref]    Analyze the current branch against a base branch
+  --pr [base-ref]        Alias for --branch, useful for PR-style comparisons
 
 Examples:
   gitxplain HEAD~1 --full
+  gitxplain HEAD~1 --review
   gitxplain HEAD~5..HEAD --markdown
   gitxplain --branch main --review
   gitxplain --pr origin/main --security --stream
+  gitxplain commit
+  gitxplain --commit --execute
+  gitxplain merge
+  gitxplain --merge --execute
+  gitxplain tag
+  gitxplain --tag --execute
+  gitxplain log
+  gitxplain --log
+  gitxplain status
+  gitxplain --status
+  gitxplain add README.md
+  gitxplain remove README.md
+  gitxplain del scratch.txt
+  gitxplain pop
+  gitxplain pop 2
+  gitxplain push
+  gitxplain push origin main
+  gitxplain HEAD~1 --split
+  gitxplain HEAD --split --execute
   gitxplain HEAD~1 --provider chutes --model deepseek-ai/DeepSeek-V3-0324
 
 Provider Setup:
@@ -124,6 +229,7 @@ Hook Installation:
 
 Notes:
   Run gitxplain inside a Git repository.
+  If no mode is supplied, gitxplain will prompt you to choose one interactively.
   Use --provider or --model to override your config or environment for one command.
 `);
 }
@@ -186,13 +292,58 @@ export function parseArgs(argv) {
   const explicitMode = [...MODE_FLAGS.entries()].find(([flag]) => flags.has(flag))?.[1] ?? null;
   const explicitFormat = [...FORMAT_FLAGS.entries()].find(([flag]) => flags.has(flag))?.[1] ?? null;
   const isInstallHook = subcommand === "install-hook";
+  const isConnectGit = flags.has("--connect-git");
+  const isBoot = flags.has("--boot");
+  const isLogCommand = subcommand === "log";
+  const isStatusCommand = subcommand === "status";
+  const isCommitCommand = subcommand === "commit";
+  const isMergeCommand = subcommand === "merge";
+  const isTagCommand = subcommand === "tag";
+  const isAddCommand = subcommand === "add";
+  const isRemoveCommand = subcommand === "remove";
+  const isDeleteCommand = subcommand === "del";
+  const isPopCommand = subcommand === "pop";
+  const isPushCommand = subcommand === "push";
 
   return {
     subcommand,
     help: flags.has("--help") || subcommand === "help",
     installHook: isInstallHook,
+    connectGit: isConnectGit,
+    boot: isBoot,
+    logCommand: isLogCommand,
+    statusCommand: isStatusCommand,
+    commitCommand: isCommitCommand,
+    mergeCommand: isMergeCommand,
+    tagCommand: isTagCommand,
+    addCommand: isAddCommand,
+    removeCommand: isRemoveCommand,
+    deleteCommand: isDeleteCommand,
+    popCommand: isPopCommand,
+    pushCommand: isPushCommand,
     hookName: isInstallHook ? positional[1] ?? "post-commit" : null,
-    commitRef: isInstallHook || subcommand === "help" ? null : positional[0] ?? null,
+    actionPaths: isAddCommand || isRemoveCommand || isDeleteCommand ? positional.slice(1) : [],
+    connectToken: isConnectGit ? positional[0] : null,
+    stashIndex: isPopCommand ? positional[1] ?? null : null,
+    pushRemote: isPushCommand ? positional[1] ?? null : null,
+    pushBranch: isPushCommand ? positional[2] ?? null : null,
+    commitRef:
+      isInstallHook ||
+      isConnectGit ||
+      isBoot ||
+      isLogCommand ||
+      isStatusCommand ||
+      isCommitCommand ||
+      isMergeCommand ||
+      isTagCommand ||
+      isAddCommand ||
+      isRemoveCommand ||
+      isDeleteCommand ||
+      isPopCommand ||
+      isPushCommand ||
+      subcommand === "help"
+        ? null
+        : positional[0] ?? null,
     mode: explicitMode,
     format: explicitFormat,
     provider: getFlagValue(args, "--provider"),
@@ -205,7 +356,13 @@ export function parseArgs(argv) {
     clipboard: flags.has("--clipboard"),
     stream: flags.has("--stream"),
     verbose: flags.has("--verbose"),
-    quiet: flags.has("--quiet")
+    quiet: flags.has("--quiet"),
+    execute: flags.has("--execute"),
+    dryRun: flags.has("--dry-run"),
+    log: flags.has("--log"),
+    status: flags.has("--status"),
+    merge: flags.has("--merge"),
+    tag: flags.has("--tag")
   };
 }
 
@@ -233,6 +390,11 @@ async function chooseModeInteractively() {
       "6. Line-by-Line Code Walkthrough",
       "7. Code Review",
       "8. Security Review",
+      "9. Split Commit",
+      "10. Merge To Release Branch",
+      "11. Tag Release Commits",
+      "12. Repository Log",
+      "13. Commit Working Tree",
       "> "
     ].join("\n")
   );
@@ -245,7 +407,12 @@ async function chooseModeInteractively() {
     "5": "full",
     "6": "lines",
     "7": "review",
-    "8": "security"
+    "8": "security",
+    "9": "split",
+    "10": "merge",
+    "11": "tag",
+    "12": "log",
+    "13": "commit"
   };
 
   return selections[answer] ?? "full";
@@ -305,8 +472,11 @@ export async function main(argv = process.argv) {
   const cwd = process.cwd();
   const config = loadConfig(cwd);
   const parsed = parseArgs(argv);
+  const hasNoCommandOrFlags = argv.slice(2).length === 0;
 
-  if (parsed.help) {
+  loadEnvFile(cwd); // Ensure environment is loaded first
+
+  if (parsed.help || hasNoCommandOrFlags) {
     printHelp();
     return 0;
   }
@@ -322,7 +492,216 @@ export async function main(argv = process.argv) {
     return 0;
   }
 
+  if (parsed.connectGit) {
+    let token = parsed.connectToken;
+    if (!token) {
+      if (process.env.GITHUB_TOKEN) {
+        token = process.env.GITHUB_TOKEN;
+      } else {
+        console.error("Please provide your GitHub Personal Access Token.\nRun: gitxplain --connect-git <YOUR_TOKEN>\nOr set it in your .env as GITHUB_TOKEN=...");
+        return 1;
+      }
+    }
+    try {
+      console.log("Verifying token with GitHub API...");
+      const userInfo = await verifyGitToken(token);
+      await saveGitConnection(token, "github", userInfo);
+      console.log(`\nSuccessfully connected to GitHub as: \x1b[36m${userInfo.login}\x1b[0m`);
+      console.log(`Token saved securely to your local configuration.\n`);
+    } catch (e) {
+      console.error(`Token verification failed: ${e.message}`);
+      return 1;
+    }
+    return 0;
+  }
+
+  if (parsed.boot) {
+    if (!isGitConnected()) {
+      console.error("You must connect a GitHub account first to use the interactive agent.\nCommand: gitxplain --connect-git <YOUR_TOKEN>");
+      return 1;
+    }
+    const connection = loadGitConnection();
+    const userInfo = getGitUserInfo();
+    try {
+      const { getProviderConfig, validateProviderConfig } = await import(
+        "./services/aiService.js"
+      );
+      const config = getProviderConfig(parsed.provider, parsed.model);
+      validateProviderConfig(config);
+      await startChatSession(connection.token, parsed.provider, parsed.model, userInfo.name || connection.user?.login);
+    } catch (configError) {
+      console.error(`Missing LLM Key. Please check your .env variables or --provider flags.\n${configError.message}`);
+      return 1;
+    }
+    return 0;
+  }
+
+  if (parsed.logCommand || parsed.log) {
+    console.log(getRepositoryLog(cwd));
+    return 0;
+  }
+
+  if (parsed.statusCommand || parsed.status) {
+    console.log(getRepositoryStatus(cwd));
+    return 0;
+  }
+
+  if (parsed.addCommand || parsed.removeCommand || parsed.deleteCommand || parsed.popCommand || parsed.pushCommand) {
+    if (!parsed.popCommand && parsed.actionPaths.length === 0) {
+      if (!parsed.pushCommand) {
+        throw new Error(`No paths provided for "${parsed.subcommand}".`);
+      }
+    }
+
+    if (parsed.addCommand) {
+      gitAddFiles(parsed.actionPaths, cwd);
+      console.log(`Staged ${parsed.actionPaths.join(", ")}.`);
+      return 0;
+    }
+
+    if (parsed.removeCommand) {
+      gitRestoreStaged(parsed.actionPaths, cwd);
+      console.log(`Unstaged ${parsed.actionPaths.join(", ")}.`);
+      return 0;
+    }
+
+    if (parsed.deleteCommand) {
+      deletePaths(parsed.actionPaths, cwd);
+      console.log(`Deleted ${parsed.actionPaths.join(", ")}.`);
+      return 0;
+    }
+
+    if (parsed.popCommand) {
+      const stashRef = resolveStashRef(parsed.stashIndex);
+      gitStashPop(parsed.stashIndex, cwd);
+      console.log(`Popped ${stashRef}.`);
+      return 0;
+    }
+
+    gitPush(cwd, parsed.pushRemote, parsed.pushBranch);
+    console.log(
+      `Pushed${parsed.pushRemote ? ` to ${parsed.pushRemote}` : ""}${parsed.pushBranch ? ` ${parsed.pushBranch}` : ""}.`
+    );
+    return 0;
+  }
+
   const runtimeOptions = resolveRuntimeOptions(parsed, config);
+  const mode = parsed.mode ?? config.mode ?? (await chooseModeInteractively());
+
+  if (mode === "commit" || parsed.commitCommand) {
+    const commitData = fetchWorkingTreeData(cwd);
+
+    if (commitData.filesChanged.length === 0 || commitData.diff === "") {
+      console.log("Working tree is clean. Nothing to commit.");
+      return 0;
+    }
+
+    const { explanation, responseMeta, promptMeta } = await generateExplanation({
+      mode: "commit",
+      commitData,
+      providerOverride: runtimeOptions.provider,
+      modelOverride: runtimeOptions.model,
+      maxDiffLines: runtimeOptions.maxDiffLines,
+      stream: false,
+      onChunk: null,
+      onStart: null
+    });
+
+    const plan = reconcileCommitPlan(parseCommitPlan(explanation), cwd);
+
+    if (!plan.reason_to_commit || plan.commits.length === 0) {
+      console.log("No meaningful commit grouping recommended.");
+      return 0;
+    }
+
+    console.log(formatCommitPlan(plan));
+
+    if (parsed.execute && !parsed.dryRun) {
+      const confirmed = await askQuestion(
+        "\nThis will create new commits from your working tree changes. Continue? (yes/no) > "
+      );
+      if (confirmed.toLowerCase() !== "yes") {
+        console.log("Aborted.");
+        return 0;
+      }
+
+      executeCommitPlan(plan, cwd);
+      console.log(`\nCommit complete. Created ${plan.commits.length} commits.`);
+    } else {
+      console.log("\nThis is a preview. Run with --execute to apply the commit plan.");
+    }
+
+    if (runtimeOptions.verbose) {
+      process.stdout.write(formatFooter({ responseMeta, promptMeta, options: runtimeOptions }));
+    }
+
+    return 0;
+  }
+
+  if (mode === "merge" || parsed.mergeCommand || parsed.merge) {
+    if (parsed.commitRef) {
+      throw new Error("--merge works from the current branch and does not accept a commit ref.");
+    }
+
+    const plan = finalizeReleaseMergePlan(buildReleaseMergePlan(cwd));
+
+    if (plan.windows.length === 0) {
+      console.log("No unreleased release commits detected. Nothing to merge.");
+      return 0;
+    }
+
+    console.log(formatReleaseMergePlan(plan));
+
+    if (parsed.execute && !parsed.dryRun) {
+      const confirmed = await askQuestion(
+        `\nThis will create ${plan.windows.length} release commit(s) on ${plan.releaseBranch}. Continue? (yes/no) > `
+      );
+      if (confirmed.toLowerCase() !== "yes") {
+        console.log("Aborted.");
+        return 0;
+      }
+
+      executeReleaseMerge(plan, cwd);
+      console.log(`\nRelease promotion complete. Created ${plan.windows.length} release commit(s) on ${plan.releaseBranch}.`);
+    } else {
+      console.log(`\nThis is a preview. Run with --execute to create release commits on ${plan.releaseBranch}.`);
+    }
+
+    return 0;
+  }
+
+  if (mode === "tag" || parsed.tagCommand || parsed.tag) {
+    if (parsed.commitRef) {
+      throw new Error("--tag works from the current branch and does not accept a commit ref.");
+    }
+
+    const plan = finalizeReleaseTagPlan(buildReleaseTagPlan(cwd));
+
+    if (plan.tags.length === 0) {
+      console.log("No unreleased release tags detected. Nothing to tag.");
+      return 0;
+    }
+
+    console.log(formatReleaseTagPlan(plan));
+
+    if (parsed.execute && !parsed.dryRun) {
+      const confirmed = await askQuestion(
+        `\nThis will create ${plan.tags.length} release tag(s). Continue? (yes/no) > `
+      );
+      if (confirmed.toLowerCase() !== "yes") {
+        console.log("Aborted.");
+        return 0;
+      }
+
+      executeReleaseTagPlan(plan, cwd);
+      console.log(`\nRelease tagging complete. Created ${plan.tags.length} release tag(s).`);
+    } else {
+      console.log("\nThis is a preview. Run with --execute to create release tags.");
+    }
+
+    return 0;
+  }
+
   const targetRef = resolveTargetRef(parsed, cwd);
 
   if (!targetRef) {
@@ -330,8 +709,56 @@ export async function main(argv = process.argv) {
     return 1;
   }
 
-  const mode = parsed.mode ?? config.mode ?? (await chooseModeInteractively());
   const commitData = fetchCommitData(targetRef, cwd);
+
+  if (mode === "split") {
+    if (commitData.analysisType !== "commit") {
+      throw new Error("--split only supports analyzing a single commit.");
+    }
+
+    const { explanation, responseMeta, promptMeta } = await generateExplanation({
+      mode: "split",
+      commitData,
+      providerOverride: runtimeOptions.provider,
+      modelOverride: runtimeOptions.model,
+      maxDiffLines: runtimeOptions.maxDiffLines,
+      stream: false,
+      onChunk: null,
+      onStart: null
+    });
+
+    const plan = reconcileSplitPlan(parseSplitPlan(explanation), commitData.filesChanged);
+
+    if (!plan.reason_to_split || plan.commits.length === 0) {
+      console.log("This commit is already atomic. No split recommended.");
+      return 0;
+    }
+
+    console.log(formatSplitPlan(plan));
+
+    if (parsed.execute && !parsed.dryRun) {
+      validateSplitExecutionTarget(commitData.commitId, cwd);
+      const confirmed = await askQuestion(
+        "\nThis will rewrite git history. Continue? (yes/no) > "
+      );
+      if (confirmed.toLowerCase() !== "yes") {
+        console.log("Aborted.");
+        return 0;
+      }
+
+      executeSplit(plan, commitData.commitId, cwd);
+      console.log(`\nSplit complete. Created ${plan.commits.length} commits.`);
+    } else {
+      console.log("\nThis is a preview. Run with --execute to apply the split.");
+    }
+
+    if (runtimeOptions.verbose) {
+      process.stdout.write(formatFooter({ responseMeta, promptMeta, options: runtimeOptions }));
+    }
+
+    return 0;
+  }
+
   const canStream = runtimeOptions.stream && runtimeOptions.format === "plain";
   let streamStarted = false;
 

package/cli/services/aiService.js

@@ -12,7 +12,7 @@ const SUPPORTED_PROVIDERS = new Set([
 ]);
 const SYSTEM_PROMPT = "You explain Git commits clearly and accurately for developers.";
 
-function getProviderConfig(providerOverride, modelOverride) {
+export function getProviderConfig(providerOverride, modelOverride) {
   const provider = (providerOverride ?? process.env.LLM_PROVIDER ?? "openai").toLowerCase();
 
   if (!SUPPORTED_PROVIDERS.has(provider)) {
@@ -79,7 +79,7 @@ function getProviderConfig(providerOverride, modelOverride) {
   };
 }
 
-function validateProviderConfig(config) {
+export function validateProviderConfig(config) {
   if (!config.model) {
     throw new Error(`No model configured for provider "${config.provider}".`);
   }