forged-cli 0.7.0 → 0.8.0

package/README.md

@@ -7,7 +7,7 @@
 [![tests](https://img.shields.io/github/actions/workflow/status/bkness/forged-cli/test.yml?branch=main&label=tests&color=00ff41&style=flat-square)](https://github.com/bkness/forged-cli/actions/workflows/test.yml)
 [![license](https://img.shields.io/npm/l/forged-cli?color=00ff41&style=flat-square)](https://github.com/bkness/forged-cli)
 
-**Forged** is a CLI toolkit for developers: a dependency security scanner, a credential generator, and a README generator, with shell and workflow tooling on the way.
+**Forged** is a CLI toolkit for developers: a guided zsh setup, a dependency security scanner, a credential generator, and a README generator.
 
 🌐 **[weballtech-brandon-kellys-projects.vercel.app](https://weballtech-brandon-kellys-projects.vercel.app/)** — full docs and feature overview
 
@@ -26,6 +26,9 @@ Requires Node.js 18 or newer. Published from GitHub Actions with [npm provenance
 ## Quick Start
 
 ```sh
+# Set up the Forged shell on this machine (asks before each step)
+forged init
+
 # Scan a project's dependencies
 forged scan ./my-app
 
@@ -38,6 +41,30 @@ forged readme
 
 ---
 
+## 🐚 Shell Setup
+
+`forged init` sets up the Forged zsh environment from my [dotfiles](https://github.com/bkness/dotfiles): the prompt, the Ctrl+P command palette, the Ctrl+G GitHub dashboard (issue → branch → commit → PR, project boards), code finder, abbreviations, and a hook that scans dependencies when you `cd` into a project.
+
+It's written for people new to the terminal. It shows the whole plan first, explains each step, and asks before doing it:
+
+1. **Homebrew on your PATH.** If Homebrew is installed but `brew` isn't found (the installer's last step is easy to miss), adds its `shellenv` line to `~/.zprofile`
+2. **Command-line tools.** Installs whichever of `git gh fzf eza bat fd zoxide starship` are missing, with Homebrew
+3. **zinit**, the plugin manager, cloned to `~/.local/share/zinit`
+4. **The dotfiles**, cloned to `~/dev/dotfiles`
+5. **One line in `~/.zshrc`** that loads them. The file is backed up first, and nothing already in it is changed
+
+Steps that are already done are skipped, so it's safe to run again after fixing an error.
+
+| Command | What it does |
+|---------|--------------|
+| `forged init` | Guided setup |
+| `forged init --dry-run` | Show the plan, change nothing |
+| `forged init --yes` | Accept every step without asking |
+
+Needs macOS or Linux. Without Homebrew (on Linux, say), init lists the missing tools for you to install yourself and does the rest.
+
+---
+
 ## 🔍 Security Scanner
 
 `forged scan [path]` audits every package in your `package-lock.json`:
@@ -140,11 +167,10 @@ These are advertised in `forged help` and currently print "coming soon":
 
 | Command | Plan |
 |---------|------|
-| `forged init` | Guided setup of a modular zsh environment — plugins, hooks, project auto-detection, and the GitHub workflow (Ctrl+G: issue → branch → commit → PR, project boards, label and template pickers) |
 | `forged new` | Create a new project with GitHub setup |
 | `forged install` | Add Forged to an existing shell config |
 
-Want them today? Everything above, including the full GitHub workflow, already runs in my [dotfiles](https://github.com/bkness/dotfiles) — `forged init` will package it.
+`forged init` already sets up the shell and GitHub workflow these build on.
 
 ---
 

package/bin/forged.js

@@ -10,6 +10,7 @@ const { version } = JSON.parse(readFileSync(join(__dirname, '../package.json'),
 const [,, command, ...args] = process.argv;
 
 const commands = {
+  init:    'Set up the Forged shell: tools, plugins, dotfiles',
   scan:    'Audit dependencies — known malware, integrity, publisher changes, typosquats',
   gen:     'Generate passwords, secrets, PINs, and UUIDs',
   readme:  'Generate a README.md for the current project',
@@ -18,7 +19,6 @@ const commands = {
 
 // Advertised but not built yet — say so instead of treating them as typos
 const planned = {
-  init:    'Scaffold a new dev environment',
   new:     'Create a new project with GitHub setup',
   install: 'Install Forged into an existing shell config',
 };
@@ -36,6 +36,11 @@ ${Object.entries(commands).map(([cmd, desc]) => `    ${cmd.padEnd(10)} ${desc}`)
   Coming soon:
 ${Object.entries(planned).map(([cmd, desc]) => `    ${cmd.padEnd(10)} ${desc}`).join('\n')}
 
+  Init options:
+    forged init [--dry-run] [--yes|-y]
+    --dry-run  show what would change, change nothing
+    --yes      accept every step without asking
+
   Scan options:
     forged scan [path] [--verbose|-v] [--report|--report-md]
                        [--changed] [--quiet|-q] [--review]
@@ -58,6 +63,11 @@ if (command === 'readme') {
   process.exit(0);
 }
 
+if (command === 'init') {
+  const { initCommand } = await import('../src/commands/init.js');
+  process.exit(await initCommand(args));
+}
+
 if (command === 'gen') {
   const { genCommand } = await import('../src/commands/gen.js');
   await genCommand(args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "forged-cli",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "A complete dev environment toolkit — shell, workflows, and project scaffolding in one install.",
   "keywords": [
     "cli",

package/src/commands/init.js

@@ -0,0 +1,242 @@
+import { spawnSync } from 'child_process';
+import { existsSync, readFileSync, writeFileSync, appendFileSync, copyFileSync, lstatSync, realpathSync } from 'fs';
+import { createInterface } from 'readline/promises';
+import { homedir } from 'os';
+import { join, delimiter, dirname } from 'path';
+
+const green  = '\x1b[32m';
+const yellow = '\x1b[33m';
+const red    = '\x1b[31m';
+const bold   = '\x1b[1m';
+const dim    = '\x1b[2m';
+const reset  = '\x1b[0m';
+
+// What the dotfiles expect on PATH, and what each one is for — shown to the
+// user so a beginner knows why we're installing it
+export const TOOLS = {
+  git:      'version control',
+  gh:       'GitHub from the terminal (Ctrl+G)',
+  fzf:      'fuzzy finder behind every picker',
+  eza:      'a nicer `ls`',
+  bat:      'a nicer `cat` with syntax colors',
+  fd:       'a faster `find`',
+  zoxide:   'jump to folders you visit often (Ctrl+J)',
+  starship: 'the prompt',
+};
+
+export const DOTFILES_REPO = 'https://github.com/bkness/dotfiles.git';
+export const ZINIT_REPO    = 'https://github.com/zdharma-continuum/zinit.git';
+export const HOOK_MARKER   = '# forged: load the Forged shell';
+
+// Where Homebrew lives when it's installed but not on PATH yet (Apple
+// Silicon, Intel, Linux). The installer prints a "Next steps" shellenv line
+// that beginners skip, which leaves `brew: command not found`.
+export const BREW_PATHS = ['/opt/homebrew/bin/brew', '/usr/local/bin/brew', '/home/linuxbrew/.linuxbrew/bin/brew'];
+
+export function paths(home) {
+  return {
+    dotfiles: join(home, 'dev', 'dotfiles'),
+    zinit:    join(home, '.local', 'share', 'zinit', 'zinit.git'),
+    zshrc:    join(home, '.zshrc'),
+    zprofile: join(home, '.zprofile'),
+  };
+}
+
+// The one block appended to ~/.zshrc. $HOME stays literal so the line still
+// works if the home folder is renamed.
+export function hookBlock() {
+  return `\n${HOOK_MARKER}\n[[ -f "$HOME/dev/dotfiles/zsh/.zshrc" ]] && source "$HOME/dev/dotfiles/zsh/.zshrc"\n`;
+}
+
+// Already loading the dotfiles: our marker, a hand-written source line, or
+// ~/.zshrc symlinked straight into the repo (how Brandon's Mac is set up)
+export function zshrcLoadsDotfiles(zshrcText, zshrcTarget) {
+  if (zshrcTarget && zshrcTarget.endsWith('/dev/dotfiles/zsh/.zshrc')) return true;
+  if (!zshrcText) return false;
+  return zshrcText.includes(HOOK_MARKER) || /source\s+\S*dev\/dotfiles\/zsh\/\.zshrc/.test(zshrcText);
+}
+
+// Everything init would do, in order, with `done` marking steps that are
+// already in place. Pure: all probing comes in through `env`.
+export function buildPlan(env) {
+  const p = paths(env.home);
+  const steps = [];
+
+  const brewOnPath = env.has('brew');
+  const brewPath = brewOnPath ? null : (env.brewPaths ?? BREW_PATHS).find(env.exists);
+
+  if (!brewOnPath && brewPath) {
+    steps.push({
+      id: 'brew-path',
+      title: 'Put Homebrew on your PATH',
+      why: `Homebrew is installed at ${brewPath}, but your shell can't find it yet. This adds one line to ~/.zprofile, the step the Homebrew installer asks you to run at the end.`,
+      line: `eval "$(${brewPath} shellenv)"`,
+      brewPath,
+      done: false,
+    });
+  }
+
+  const brewAvailable = brewOnPath || Boolean(brewPath);
+  const missing = Object.keys(TOOLS).filter((t) => !env.has(t));
+  steps.push({
+    id: 'tools',
+    title: 'Install command-line tools',
+    why: missing.length
+      ? `Missing: ${missing.map((t) => `${t} (${TOOLS[t]})`).join(', ')}.`
+      : 'All installed.',
+    missing,
+    brewAvailable,
+    // Full path when it isn't on PATH, so this works even if step 1 was skipped
+    brew: brewOnPath ? 'brew' : brewPath,
+    done: missing.length === 0,
+  });
+
+  steps.push({
+    id: 'zinit',
+    title: 'Install zinit, the zsh plugin manager',
+    why: 'It loads autosuggestions, syntax highlighting, fuzzy tab completion and abbreviations.',
+    dir: p.zinit,
+    done: env.exists(p.zinit),
+  });
+
+  steps.push({
+    id: 'dotfiles',
+    title: 'Download the Forged shell config',
+    why: `Clones ${DOTFILES_REPO} to ~/dev/dotfiles: the prompt, widgets (Ctrl+P, Ctrl+G, Ctrl+F…), aliases and hooks.`,
+    dir: p.dotfiles,
+    done: env.exists(p.dotfiles),
+  });
+
+  const zshrcText = env.exists(p.zshrc) ? env.read(p.zshrc) : null;
+  steps.push({
+    id: 'zshrc',
+    title: 'Load it from ~/.zshrc',
+    why: zshrcText === null
+      ? 'Creates ~/.zshrc with one line that loads the Forged shell.'
+      : 'Backs up ~/.zshrc, then adds one line at the end that loads the Forged shell. Nothing already in the file is changed.',
+    file: p.zshrc,
+    exists: zshrcText !== null,
+    done: zshrcLoadsDotfiles(zshrcText, env.symlinkTarget(p.zshrc)),
+  });
+
+  return steps;
+}
+
+export function realEnv(home) {
+  return {
+    home,
+    brewPaths: BREW_PATHS,
+    has: (cmd) => (process.env.PATH || '').split(delimiter).some((dir) => dir && existsSync(join(dir, cmd))),
+    exists: existsSync,
+    read: (file) => readFileSync(file, 'utf8'),
+    symlinkTarget: (file) => {
+      try { return lstatSync(file).isSymbolicLink() ? realpathSync(file) : null; } catch { return null; }
+    },
+  };
+}
+
+const runCommand = (cmd, args) => spawnSync(cmd, args, { stdio: 'inherit' }).status === 0;
+
+// Carries out one step: true when done, false when it failed (init stops so
+// later steps don't build on a broken one), 'manual' when the user has to do
+// it themselves.
+function apply(step, home, run) {
+  switch (step.id) {
+    case 'brew-path': {
+      appendFileSync(paths(home).zprofile, `\n${step.line}\n`);
+      // Later steps in this same run need brew too
+      process.env.PATH = `${dirname(step.brewPath)}${delimiter}${process.env.PATH}`;
+      return true;
+    }
+    case 'tools': {
+      if (!step.brewAvailable) {
+        console.log(`  ${yellow}Homebrew isn't installed, so install these yourself:${reset} ${bold}${step.missing.join(' ')}${reset}`);
+        console.log(`  ${dim}On a Mac, get Homebrew from https://brew.sh and run forged init again. On Linux, use your package manager.${reset}`);
+        return 'manual';
+      }
+      return run(step.brew, ['install', ...step.missing]);
+    }
+    case 'zinit':
+      return run('git', ['clone', '--depth', '1', ZINIT_REPO, step.dir]);
+    case 'dotfiles':
+      return run('git', ['clone', DOTFILES_REPO, step.dir]);
+    case 'zshrc': {
+      if (step.exists) {
+        const backup = `${step.file}.forged-backup-${Date.now()}`;
+        copyFileSync(step.file, backup);
+        console.log(`  ${dim}Backed up to ${backup}${reset}`);
+        appendFileSync(step.file, hookBlock());
+      } else {
+        writeFileSync(step.file, hookBlock().trimStart());
+      }
+      return true;
+    }
+  }
+  return false;
+}
+
+// `env` and `run` are swappable so tests never touch the real Homebrew
+export async function initCommand(args, { home = homedir(), env = realEnv(home), run = runCommand } = {}) {
+  const yes    = args.includes('--yes') || args.includes('-y');
+  const dryRun = args.includes('--dry-run');
+
+  console.log(`\n  ${green}⚒  Forged init${reset} — set up the Forged shell on this machine\n`);
+
+  if (process.platform === 'win32') {
+    console.log(`  ${red}The Forged shell is zsh-based and needs macOS or Linux.${reset}\n`);
+    return 1;
+  }
+
+  const plan = buildPlan(env);
+  const todo = plan.filter((s) => !s.done);
+
+  plan.forEach((s, i) => {
+    const mark = s.done ? `${green}✓${reset}` : `${yellow}○${reset}`;
+    console.log(`  ${mark} ${i + 1}. ${s.title}${s.done ? ` ${dim}(already done)${reset}` : ''}`);
+  });
+  console.log();
+
+  if (todo.length === 0) {
+    console.log(`  ${green}Everything's already set up.${reset} Open a new terminal tab to use it.\n`);
+    return 0;
+  }
+
+  if (dryRun) {
+    for (const s of todo) console.log(`  ${bold}${s.title}${reset}\n  ${dim}${s.why}${reset}\n`);
+    console.log(`  ${dim}Dry run: nothing was changed.${reset}\n`);
+    return 0;
+  }
+
+  if (!yes && !process.stdin.isTTY) {
+    console.log(`  No terminal to ask in. Run ${bold}forged init --yes${reset} to accept every step.\n`);
+    return 1;
+  }
+
+  const rl = yes ? null : createInterface({ input: process.stdin, output: process.stdout });
+  try {
+    for (const s of todo) {
+      console.log(`  ${bold}${s.title}${reset}\n  ${dim}${s.why}${reset}`);
+      if (rl) {
+        const answer = (await rl.question(`  Do it? ${dim}[Y/n]${reset} `)).trim().toLowerCase();
+        if (answer && answer !== 'y' && answer !== 'yes') {
+          console.log(`  ${dim}Skipped.${reset}\n`);
+          continue;
+        }
+      }
+      const result = apply(s, home, run);
+      if (!result) {
+        console.log(`\n  ${red}✗ ${s.title} didn't finish.${reset} Fix the error above, then run ${bold}forged init${reset} again; finished steps are skipped.\n`);
+        return 1;
+      }
+      console.log(result === 'manual' ? '' : `  ${green}✓ Done${reset}\n`);
+    }
+  } finally {
+    rl?.close();
+  }
+
+  console.log(`  ${green}${bold}All set.${reset} Next:`);
+  console.log(`    ${bold}exec zsh${reset}          load the new shell in this window`);
+  console.log(`    ${bold}gh auth login${reset}     connect GitHub, for the Ctrl+G dashboard`);
+  console.log(`    ${bold}Ctrl+P${reset}            browse every command\n`);
+  return 0;
+}