@manthank/mgit 1.0.0

package/dist/catalog.js

@@ -0,0 +1,585 @@
+// The heart of mgit: a data-driven catalog of every git action, grouped into
+// friendly categories. Each action carries a beginner explanation, the git args
+// to run (optionally built from prompted inputs), and safety flags.
+//
+// Action shape:
+//   id, label, hint (plain-English what/why),
+//   inputs: [{name, label, placeholder, optional, default}]  (optional)
+//   build: (values) => string[]   -> git arguments
+//   danger: boolean               -> ask for confirmation
+//   view: 'status' | 'branches' | 'log' | 'config' | 'contrib'  (special screens)
+//   needsRepo: boolean (default true)
+
+const t = (str, values) => str.replace(/\{(\w+)\}/g, (_, k) => values[k] ?? '');
+export const categories = [{
+  id: 'start',
+  label: 'Get Started',
+  emoji: '🚀',
+  blurb: 'Set up git and create or clone a repository.',
+  actions: [{
+    id: 'wizard-identity',
+    label: 'Setup wizard — name, email & default branch',
+    hint: 'Runs once per machine. Tells git who you are so your commits are signed with your name, and sets "main" as the default branch.',
+    view: 'setup',
+    needsRepo: false
+  }, {
+    id: 'config-list',
+    label: 'View my git config',
+    hint: 'Lists every setting git currently uses (name, email, editor, aliases…).',
+    view: 'config',
+    needsRepo: false
+  }, {
+    id: 'init',
+    label: 'Initialize a repo here (git init)',
+    hint: 'Turns the current folder into a git repository so you can start tracking changes.',
+    build: () => ['init'],
+    needsRepo: false
+  }, {
+    id: 'clone',
+    label: 'Clone an existing repo (git clone)',
+    hint: 'Downloads a full copy of a remote repository to your machine.',
+    inputs: [{
+      name: 'url',
+      label: 'Repository URL',
+      placeholder: 'https://github.com/user/repo.git'
+    }, {
+      name: 'folder',
+      label: 'Folder name (optional)',
+      placeholder: 'leave blank for default',
+      optional: true
+    }],
+    build: v => v.folder ? ['clone', v.url, v.folder] : ['clone', v.url],
+    needsRepo: false
+  }]
+}, {
+  id: 'inspect',
+  label: 'See What Changed',
+  emoji: '🔎',
+  blurb: 'Status, differences and history at a glance.',
+  actions: [{
+    id: 'status',
+    label: 'Status dashboard',
+    hint: 'A colour-coded view of modified, new, deleted and staged files.',
+    view: 'status'
+  }, {
+    id: 'diff',
+    label: 'Show unstaged changes (git diff)',
+    hint: 'Line-by-line changes you have NOT staged yet.',
+    build: () => ['--no-pager', 'diff']
+  }, {
+    id: 'diff-staged',
+    label: 'Show staged changes (git diff --staged)',
+    hint: 'The changes that WILL go into your next commit.',
+    build: () => ['--no-pager', 'diff', '--staged']
+  }, {
+    id: 'diff-names',
+    label: 'List changed file names',
+    hint: 'Just the filenames that changed — no diff detail.',
+    build: () => ['--no-pager', 'diff', '--name-only']
+  }, {
+    id: 'show',
+    label: 'Show a commit (git show)',
+    hint: 'Full details and diff of a single commit. Leave blank for the latest.',
+    inputs: [{
+      name: 'ref',
+      label: 'Commit id',
+      placeholder: 'blank = HEAD',
+      optional: true
+    }],
+    build: v => v.ref ? ['--no-pager', 'show', v.ref] : ['--no-pager', 'show']
+  }, {
+    id: 'blame',
+    label: 'Blame — who changed each line',
+    hint: 'Shows the author and commit responsible for every line of a file.',
+    inputs: [{
+      name: 'file',
+      label: 'File path',
+      placeholder: 'src/app.js'
+    }],
+    build: v => ['--no-pager', 'blame', v.file]
+  }, {
+    id: 'grep',
+    label: 'Search code (git grep)',
+    hint: 'Fast search for text across all tracked files.',
+    inputs: [{
+      name: 'q',
+      label: 'Search text',
+      placeholder: 'functionName'
+    }],
+    build: v => ['--no-pager', 'grep', '-n', v.q]
+  }]
+}, {
+  id: 'history',
+  label: 'History & Graph',
+  emoji: '📈',
+  blurb: 'Visualize commits and branches as a chart.',
+  actions: [{
+    id: 'log-graph',
+    label: 'Commit graph (visual chart)',
+    hint: 'An animated ASCII graph of commits across all branches.',
+    view: 'log'
+  }, {
+    id: 'contrib',
+    label: 'Contributions chart (git shortlog)',
+    hint: 'A bar chart of commits per author.',
+    view: 'contrib'
+  }, {
+    id: 'log-oneline',
+    label: 'Compact history (git log --oneline)',
+    hint: 'One line per commit — quick to scan.',
+    build: () => ['--no-pager', 'log', '--oneline', '-30']
+  }, {
+    id: 'reflog',
+    label: 'Reflog — where HEAD has been',
+    hint: 'A safety net: every place HEAD pointed, even after resets. Great for recovering "lost" commits.',
+    build: () => ['--no-pager', 'reflog', '-30']
+  }, {
+    id: 'shortlog',
+    label: 'Shortlog summary',
+    hint: 'Commits grouped by author.',
+    build: () => ['--no-pager', 'shortlog', '-sn', '--all']
+  }]
+}, {
+  id: 'stage',
+  label: 'Stage & Commit',
+  emoji: '📦',
+  blurb: 'Add files to the staging area and record commits.',
+  actions: [{
+    id: 'add-all',
+    label: 'Stage everything (git add .)',
+    hint: 'Stages all new and changed files, ready to commit.',
+    build: () => ['add', '.']
+  }, {
+    id: 'add-file',
+    label: 'Stage specific file(s)',
+    hint: 'Stage only the files you name (space-separated).',
+    inputs: [{
+      name: 'files',
+      label: 'File(s)',
+      placeholder: 'file1.txt file2.txt'
+    }],
+    build: v => ['add', ...v.files.split(/\s+/).filter(Boolean)]
+  }, {
+    id: 'add-tracked',
+    label: 'Stage tracked changes only (git add -u)',
+    hint: 'Stages modifications & deletions of already-tracked files, ignoring brand-new files.',
+    build: () => ['add', '-u']
+  }, {
+    id: 'commit',
+    label: 'Commit staged changes',
+    hint: 'Saves a snapshot of your staged files with a message.',
+    inputs: [{
+      name: 'msg',
+      label: 'Commit message',
+      placeholder: 'Add login screen'
+    }],
+    build: v => ['commit', '-m', v.msg]
+  }, {
+    id: 'commit-am',
+    label: 'Stage tracked + commit (git commit -am)',
+    hint: 'Shortcut: stages tracked changes and commits in one step.',
+    inputs: [{
+      name: 'msg',
+      label: 'Commit message',
+      placeholder: 'Fixed bug'
+    }],
+    build: v => ['commit', '-am', v.msg]
+  }]
+}, {
+  id: 'branch',
+  label: 'Branches',
+  emoji: '🌿',
+  blurb: 'Create, switch, merge and delete branches.',
+  actions: [{
+    id: 'branch-view',
+    label: 'Branch map (visual)',
+    hint: 'See all branches, which one you are on, and their latest commit.',
+    view: 'branches'
+  }, {
+    id: 'current-branch',
+    label: 'Show current branch',
+    hint: 'Prints the branch you are currently on.',
+    build: () => ['branch', '--show-current']
+  }, {
+    id: 'switch-create',
+    label: 'Create & switch to a new branch',
+    hint: 'Makes a new branch and moves you onto it (git switch -c).',
+    inputs: [{
+      name: 'name',
+      label: 'New branch name',
+      placeholder: 'feature/login'
+    }],
+    build: v => ['switch', '-c', v.name]
+  }, {
+    id: 'switch',
+    label: 'Switch to an existing branch',
+    hint: 'Moves you onto another branch (git switch).',
+    inputs: [{
+      name: 'name',
+      label: 'Branch name',
+      placeholder: 'main'
+    }],
+    build: v => ['switch', v.name]
+  }, {
+    id: 'branch-create',
+    label: 'Create branch (no switch)',
+    hint: 'Creates a branch but keeps you where you are.',
+    inputs: [{
+      name: 'name',
+      label: 'Branch name',
+      placeholder: 'feature'
+    }],
+    build: v => ['branch', v.name]
+  }, {
+    id: 'merge',
+    label: 'Merge a branch into current',
+    hint: 'Brings another branch\'s commits into the branch you are on.',
+    inputs: [{
+      name: 'name',
+      label: 'Branch to merge in',
+      placeholder: 'feature'
+    }],
+    build: v => ['merge', v.name]
+  }, {
+    id: 'branch-delete',
+    label: 'Delete a branch (safe)',
+    hint: 'Deletes a branch that is already merged (git branch -d).',
+    inputs: [{
+      name: 'name',
+      label: 'Branch name',
+      placeholder: 'feature'
+    }],
+    build: v => ['branch', '-d', v.name]
+  }, {
+    id: 'branch-delete-force',
+    label: 'Force-delete a branch',
+    hint: 'Deletes a branch even if not merged. You may lose commits!',
+    inputs: [{
+      name: 'name',
+      label: 'Branch name',
+      placeholder: 'feature'
+    }],
+    build: v => ['branch', '-D', v.name],
+    danger: true
+  }]
+}, {
+  id: 'remote',
+  label: 'Remotes, Push & Pull',
+  emoji: '🛰️',
+  blurb: 'Connect to GitHub and sync your work.',
+  actions: [{
+    id: 'remote-v',
+    label: 'View remotes (git remote -v)',
+    hint: 'Lists the remote repositories (like GitHub) this repo is linked to.',
+    build: () => ['remote', '-v']
+  }, {
+    id: 'remote-add',
+    label: 'Add a remote (origin)',
+    hint: 'Links your local repo to a GitHub URL named "origin".',
+    inputs: [{
+      name: 'url',
+      label: 'Remote URL',
+      placeholder: 'https://github.com/user/repo.git'
+    }],
+    build: v => ['remote', 'add', 'origin', v.url]
+  }, {
+    id: 'remote-seturl',
+    label: 'Change remote URL',
+    hint: 'Points "origin" at a different URL.',
+    inputs: [{
+      name: 'url',
+      label: 'New URL',
+      placeholder: 'https://github.com/user/repo.git'
+    }],
+    build: v => ['remote', 'set-url', 'origin', v.url]
+  }, {
+    id: 'remote-remove',
+    label: 'Remove remote origin',
+    hint: 'Unlinks the "origin" remote.',
+    build: () => ['remote', 'remove', 'origin'],
+    danger: true
+  }, {
+    id: 'push-first',
+    label: 'First push (git push -u origin <branch>)',
+    hint: 'Publishes your branch to GitHub and remembers it for future pushes.',
+    inputs: [{
+      name: 'branch',
+      label: 'Branch',
+      placeholder: 'main',
+      default: 'main'
+    }],
+    build: v => ['push', '-u', 'origin', v.branch || 'main']
+  }, {
+    id: 'push',
+    label: 'Push (git push)',
+    hint: 'Uploads your commits to the already-linked remote branch.',
+    build: () => ['push']
+  }, {
+    id: 'pull',
+    label: 'Pull (git pull)',
+    hint: 'Downloads and merges the latest changes from the remote.',
+    build: () => ['pull']
+  }, {
+    id: 'fetch',
+    label: 'Fetch (git fetch)',
+    hint: 'Downloads remote changes WITHOUT merging — safe to inspect first.',
+    build: () => ['fetch', '--all']
+  }, {
+    id: 'push-force',
+    label: 'Force push (overwrite remote)',
+    hint: 'Overwrites the remote branch with yours. Can destroy others\' work — use with care!',
+    inputs: [{
+      name: 'branch',
+      label: 'Branch',
+      placeholder: 'main',
+      default: 'main'
+    }],
+    build: v => ['push', 'origin', v.branch || 'main', '--force'],
+    danger: true
+  }]
+}, {
+  id: 'undo',
+  label: 'Undo & Recover',
+  emoji: '⏪',
+  blurb: 'Restore files, reset, revert and clean.',
+  actions: [{
+    id: 'restore-file',
+    label: 'Discard changes in a file',
+    hint: 'Throws away unstaged edits in a file, restoring the last committed version.',
+    inputs: [{
+      name: 'file',
+      label: 'File path',
+      placeholder: 'file.txt'
+    }],
+    build: v => ['restore', v.file],
+    danger: true
+  }, {
+    id: 'restore-all',
+    label: 'Discard ALL unstaged changes',
+    hint: 'Reverts every unstaged change back to the last commit.',
+    build: () => ['restore', '.'],
+    danger: true
+  }, {
+    id: 'unstage',
+    label: 'Unstage a file (git restore --staged)',
+    hint: 'Removes a file from the staging area but keeps your edits.',
+    inputs: [{
+      name: 'file',
+      label: 'File path',
+      placeholder: 'file.txt'
+    }],
+    build: v => ['restore', '--staged', v.file]
+  }, {
+    id: 'reset',
+    label: 'Unstage everything (git reset)',
+    hint: 'Clears the staging area; your file contents are untouched.',
+    build: () => ['reset']
+  }, {
+    id: 'undo-soft',
+    label: 'Undo last commit, keep changes staged (--soft)',
+    hint: 'Removes the last commit but keeps its changes staged, ready to re-commit.',
+    build: () => ['reset', '--soft', 'HEAD~1'],
+    danger: true
+  }, {
+    id: 'undo-mixed',
+    label: 'Undo last commit, keep changes unstaged (--mixed)',
+    hint: 'Removes the last commit and unstages its changes, but keeps the file edits.',
+    build: () => ['reset', '--mixed', 'HEAD~1'],
+    danger: true
+  }, {
+    id: 'undo-hard',
+    label: 'Undo last commit, DELETE changes (--hard)',
+    hint: 'Removes the last commit AND discards its changes forever. Cannot be undone easily!',
+    build: () => ['reset', '--hard', 'HEAD~1'],
+    danger: true
+  }, {
+    id: 'revert',
+    label: 'Revert a commit safely (git revert)',
+    hint: 'Creates a NEW commit that undoes an old one — history stays intact. Safe for shared branches.',
+    inputs: [{
+      name: 'ref',
+      label: 'Commit id',
+      placeholder: 'a1b2c3d'
+    }],
+    build: v => ['revert', '--no-edit', v.ref]
+  }, {
+    id: 'clean',
+    label: 'Delete untracked files (git clean -fd)',
+    hint: 'Permanently removes files git isn\'t tracking (e.g. build junk). No undo!',
+    build: () => ['clean', '-fd'],
+    danger: true
+  }]
+}, {
+  id: 'stash',
+  label: 'Stash',
+  emoji: '🧰',
+  blurb: 'Shelve work-in-progress temporarily.',
+  actions: [{
+    id: 'stash-save',
+    label: 'Stash current changes',
+    hint: 'Tucks away your uncommitted changes so you have a clean slate.',
+    build: () => ['stash', 'push']
+  }, {
+    id: 'stash-list',
+    label: 'List stashes',
+    hint: 'Shows everything you have stashed away.',
+    build: () => ['stash', 'list']
+  }, {
+    id: 'stash-pop',
+    label: 'Restore latest stash (pop)',
+    hint: 'Brings back your most recent stash and removes it from the list.',
+    build: () => ['stash', 'pop']
+  }, {
+    id: 'stash-apply',
+    label: 'Apply latest stash (keep it)',
+    hint: 'Brings back your stash but keeps a copy in the list.',
+    build: () => ['stash', 'apply']
+  }, {
+    id: 'stash-drop',
+    label: 'Drop latest stash',
+    hint: 'Deletes the most recent stash.',
+    build: () => ['stash', 'drop'],
+    danger: true
+  }, {
+    id: 'stash-clear',
+    label: 'Clear all stashes',
+    hint: 'Deletes every stash. Cannot be undone.',
+    build: () => ['stash', 'clear'],
+    danger: true
+  }]
+}, {
+  id: 'files',
+  label: 'Files & Tags',
+  emoji: '🏷️',
+  blurb: 'Move, remove, ignore files and manage tags.',
+  actions: [{
+    id: 'rm',
+    label: 'Remove a file (git rm)',
+    hint: 'Deletes a file and stages the deletion.',
+    inputs: [{
+      name: 'file',
+      label: 'File path',
+      placeholder: 'file.txt'
+    }],
+    build: v => ['rm', v.file],
+    danger: true
+  }, {
+    id: 'rm-dir',
+    label: 'Remove a folder (git rm -r)',
+    hint: 'Deletes a folder and its contents, staging the deletion.',
+    inputs: [{
+      name: 'dir',
+      label: 'Folder path',
+      placeholder: 'oldfolder'
+    }],
+    build: v => ['rm', '-r', v.dir],
+    danger: true
+  }, {
+    id: 'mv',
+    label: 'Rename / move a file (git mv)',
+    hint: 'Renames or moves a file while keeping its history.',
+    inputs: [{
+      name: 'from',
+      label: 'From',
+      placeholder: 'old.txt'
+    }, {
+      name: 'to',
+      label: 'To',
+      placeholder: 'new.txt'
+    }],
+    build: v => ['mv', v.from, v.to]
+  }, {
+    id: 'gitignore',
+    label: 'Create a starter .gitignore',
+    hint: 'Writes a sensible .gitignore (node_modules, dist, .env…) so junk stays out of git.',
+    view: 'gitignore'
+  }, {
+    id: 'ls-files',
+    label: 'List tracked files (git ls-files)',
+    hint: 'Every file git is currently tracking.',
+    build: () => ['ls-files']
+  }, {
+    id: 'tag-list',
+    label: 'List tags',
+    hint: 'Shows all version tags (like v1.0).',
+    build: () => ['tag']
+  }, {
+    id: 'tag-create',
+    label: 'Create a tag',
+    hint: 'Marks a point in history, usually a release version.',
+    inputs: [{
+      name: 'name',
+      label: 'Tag name',
+      placeholder: 'v1.0'
+    }],
+    build: v => ['tag', v.name]
+  }, {
+    id: 'tag-push',
+    label: 'Push a tag to remote',
+    hint: 'Uploads a tag to GitHub so it appears in releases.',
+    inputs: [{
+      name: 'name',
+      label: 'Tag name',
+      placeholder: 'v1.0'
+    }],
+    build: v => ['push', 'origin', v.name]
+  }]
+}, {
+  id: 'advanced',
+  label: 'Advanced',
+  emoji: '🧪',
+  blurb: 'Cherry-pick, rebase and rewrite history.',
+  actions: [{
+    id: 'cherry-pick',
+    label: 'Cherry-pick a commit',
+    hint: 'Copies one commit from another branch onto your current branch.',
+    inputs: [{
+      name: 'ref',
+      label: 'Commit id',
+      placeholder: 'a1b2c3d'
+    }],
+    build: v => ['cherry-pick', v.ref]
+  }, {
+    id: 'rebase',
+    label: 'Rebase onto a branch',
+    hint: 'Replays your commits on top of another branch for a cleaner, linear history.',
+    inputs: [{
+      name: 'branch',
+      label: 'Base branch',
+      placeholder: 'main'
+    }],
+    build: v => ['rebase', v.branch],
+    danger: true
+  }, {
+    id: 'rev-parse',
+    label: 'Show current commit hash (rev-parse HEAD)',
+    hint: 'Prints the full SHA of the commit you are on.',
+    build: () => ['rev-parse', 'HEAD']
+  }]
+}, {
+  id: 'recipes',
+  label: 'Guided Recipes',
+  emoji: '🍳',
+  blurb: 'Step-by-step multi-command workflows.',
+  actions: [{
+    id: 'recipe-github-first',
+    label: 'Publish this folder to GitHub (first time)',
+    hint: 'init → add → commit → set branch main → add origin → push. A guided end-to-end flow.',
+    view: 'recipe',
+    recipe: 'github-first',
+    needsRepo: false
+  }, {
+    id: 'recipe-feature',
+    label: 'Start a feature branch workflow',
+    hint: 'pull → create branch → (you code) → add → commit → push. The everyday team workflow.',
+    view: 'recipe',
+    recipe: 'feature'
+  }, {
+    id: 'recipe-sync-main',
+    label: 'Sync my main branch',
+    hint: 'switch to main → pull origin main. Keeps your main up to date.',
+    view: 'recipe',
+    recipe: 'sync-main'
+  }]
+}];
+export { t };

package/dist/cli.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+// mgit — interactive, animated git/GitHub companion for beginners.
+import React from 'react';
+import { render } from 'ink';
+import App from './app.js';
+import { loadConfig } from './config.js';
+import { jsx as _jsx } from "react/jsx-runtime";
+const args = process.argv.slice(2);
+if (args.includes('--version') || args.includes('-v')) {
+  console.log('mgit 1.0.0');
+  process.exit(0);
+}
+if (args.includes('--help') || args.includes('-h')) {
+  console.log(`
+  mgit — a friendly, animated terminal UI for learning git & GitHub.
+
+  Usage:
+    mgit            Launch the interactive app
+    mgit --version  Print version
+    mgit --help     Show this message
+
+  Inside the app:
+    ↑ ↓ / Enter     Navigate & select
+    Esc             Go back / quit
+    t               Cycle theme
+    s               Settings & themes
+    ?               Help
+`);
+  process.exit(0);
+}
+
+// Ink needs a real interactive terminal for keyboard input.
+if (!process.stdout.isTTY) {
+  console.error('mgit needs an interactive terminal (TTY). Run it directly in your terminal.');
+  process.exit(1);
+}
+const config = loadConfig();
+const {
+  waitUntilExit
+} = render(/*#__PURE__*/_jsx(App, {
+  initialConfig: config
+}), {
+  exitOnCtrlC: true
+});
+waitUntilExit().then(() => {
+  // Clear a little space so the shell prompt returns cleanly.
+  process.stdout.write('\n');
+});

package/dist/components/Footer.js

@@ -0,0 +1,38 @@
+// Persistent hint bar shown at the bottom of every screen.
+import React from 'react';
+import { Box, Text } from 'ink';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+export default function Footer({
+  theme,
+  hints,
+  repo
+}) {
+  return /*#__PURE__*/_jsxs(Box, {
+    marginTop: 1,
+    justifyContent: "space-between",
+    children: [/*#__PURE__*/_jsx(Box, {
+      children: hints.map((h, i) => /*#__PURE__*/_jsxs(Text, {
+        color: theme.muted,
+        children: [/*#__PURE__*/_jsx(Text, {
+          color: theme.accent,
+          bold: true,
+          children: h.key
+        }), /*#__PURE__*/_jsxs(Text, {
+          children: [" ", h.label, "   "]
+        })]
+      }, i))
+    }), /*#__PURE__*/_jsxs(Text, {
+      color: theme.muted,
+      children: [repo ? /*#__PURE__*/_jsx(Text, {
+        color: theme.success,
+        children: "\u25CF repo"
+      }) : /*#__PURE__*/_jsx(Text, {
+        color: theme.warn,
+        children: "\u25CB no repo"
+      }), /*#__PURE__*/_jsxs(Text, {
+        color: theme.muted,
+        children: ["  ", theme.emoji, " ", theme.label]
+      })]
+    })]
+  });
+}