gitwrit 0.2.6 → 0.2.8

package/README.md

@@ -4,7 +4,7 @@
 
 Made for `git`-ters and `writ`-ters.
 
-**gitwrit** watches your Markdown files and quietly commits and pushes them to your Git repository — no manual `git add`, no `git commit`, no `git push`. You write. gitwrit handles the rest.
+**gitwrit** watches your Markdown files and quietly commits and pushes them to your Git repository—no manual `git add`, no `git commit`, no `git push`. You write. gitwrit handles the rest.
 
 It is built for engineers writing internal specs, researchers building private knowledge bases, AI practitioners documenting models and experiments, and anyone who wants the safety of version control without the overhead of Git discipline. Your files stay in your own repository, on your own terms—not in someone else's cloud.
 
@@ -99,9 +99,9 @@ Run `gitwrit config` from inside a watched directory to set local overrides. Ove
 
 gitwrit supports two branch modes, configurable globally or per directory.
 
-**`current`** — Commits to whatever branch you currently have checked out. Switch branches freely; gitwrit follows you.
+**`current`**—Commits to whatever branch you currently have checked out. Switch branches freely; gitwrit follows you.
 
-**`autogenerated`** — Creates a fresh named branch at the start of each session. Branch names are generated by combining a random adjective, noun, and verb — like `crimson-walrus-stumbling` or `teal-fox-bouncing`. 64,000 possible combinations. Good for keeping autosave history separate from your main branch.
+**`autogenerated`**—Creates a fresh named branch at the start of each session. Branch names are generated by combining a random adjective, noun, and verb—like `crimson-walrus-stumbling` or `teal-fox-bouncing`. 64,000 possible combinations. Good for keeping autosave history separate from your main branch.
 
 ---
 
@@ -113,16 +113,51 @@ gitwrit checks for updates automatically after every command. If a newer version
   · Update available: 0.2.1 → 0.3.0   Run npm install -g gitwrit to update.
 ```
 
-
 The check runs in the background, caches for 24 hours, and fails silently if you are offline. It will never interrupt or slow down your workflow.
 
 ---
 
+## Compatibility
+
+| Platform | Status |
+|---|---|
+| macOS | ✅ Fully supported |
+| Linux | ✅ Fully supported |
+| Windows | ❌ Not currently supported |
+
+gitwrit is built for macOS and Linux. Windows is not currently supported—the daemon process management and file system watching rely on POSIX signals (`SIGTERM`, `SIGCONT`) that are not available on Windows.
+
+If you are a Windows user and would like to contribute Windows support, please open an issue on [GitHub](https://github.com/TBiddy/gitwrit)—it is a welcome contribution.
+
+---
+
 ## Requirements
 
 - Node.js ≥ 18
 - Git
-- A configured Git remote (`git remote add origin <url>`) — gitwrit requires one before it will initialize a directory
+- A configured Git remote (`git remote add origin <url>`)—gitwrit requires one before it will initialize a directory
+
+---
+
+## Troubleshooting
+
+**gitwrit isn't committing my changes**
+
+gitwrit watches for file save events. Make sure your editor is actually saving to disk—some terminal editors like Pico and Nano require an explicit save (`Ctrl+X` → `Y`) before changes hit the filesystem. gitwrit cannot commit changes that haven't been written to disk yet.
+
+**Push failed notification**
+
+If gitwrit notifies you that a push failed, first verify that git can push manually from your terminal:
+
+```sh
+git push
+```
+
+If that works, restart gitwrit with `gitwrit restart`. If it fails, fix your Git authentication first—gitwrit can only push if git itself can push from a non-interactive terminal session. Make sure your SSH key is configured and registered with your Git provider, or that your HTTPS credentials are cached.
+
+**Something else feels off**
+
+`gitwrit logs` is always your first stop. It shows a timestamped record of every commit, push, and error the daemon has encountered.
 
 ---
 

package/bin/gitwrit.js

@@ -1,6 +1,9 @@
 #!/usr/bin/env node
 
 import { Command } from 'commander';
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
 import { init }    from '../src/commands/init.js';
 import { start }   from '../src/commands/start.js';
 import { stop }    from '../src/commands/stop.js';
@@ -15,12 +18,18 @@ import { checkForUpdate, currentVersion } from '../src/updater.js';
 import chalk from 'chalk';
 import { TEAL, PINK } from '../src/ui.js';
 
+// ── dynamic version from package.json ────────────────────────────────────────
+// never hardcode the version — read it directly from package.json so
+// gitwrit --version always matches the published version automatically.
+const require = createRequire(import.meta.url);
+const PKG = require(join(dirname(fileURLToPath(import.meta.url)), '../package.json'));
+
 const program = new Command();
 
 program
   .name('gitwrit')
   .description('Private, versioned writing for people who live in the terminal.')
-  .version('0.2.1')
+  .version(PKG.version)
   .addHelpCommand(false)
   .helpOption(false);
 
@@ -76,8 +85,7 @@ if (process.argv.length <= 2) {
 }
 
 // ── run command then check for updates ───────────────────────────────────────
-// update check runs after the command completes so it never delays the user.
-// shows a single hint line at the bottom if a newer version is available.
+// runs after the command completes — never blocks or delays the user.
 program.parseAsync(process.argv).then(async () => {
   const latest = await checkForUpdate();
   if (latest) {
@@ -88,7 +96,7 @@ program.parseAsync(process.argv).then(async () => {
       chalk.dim(' → ') +
       chalk.hex(PINK).bold(latest) +
       chalk.dim('   Run ') +
-      chalk.white('npm install -g gitwrit') +
+      chalk.white('npm install -g gitwrit@latest') +
       chalk.dim(' to update.')
     );
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitwrit",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Private, versioned writing for people who live in the terminal.",
   "type": "module",
   "license": "MIT",

package/src/commands/status.js

@@ -1,9 +1,13 @@
 import { readFile } from 'fs/promises';
-import { print, timeAgo } from '../ui.js';
+import boxen from 'boxen';
+import chalk from 'chalk';
+import { print, timeAgo, TEAL, PINK } from '../ui.js';
 import { PID_FILE } from '../paths.js';
 import { readState, STATE } from '../state.js';
 import { loadGlobalConfig, globalConfigExists } from '../settings.js';
 
+// ─── helpers ──────────────────────────────────────────────────────────────────
+
 async function getLivePid() {
   try {
     const raw = await readFile(PID_FILE, 'utf8');
@@ -23,6 +27,27 @@ function formatUptime(startedAt) {
   return `${Math.floor(seconds / 3600)}h ${Math.floor((seconds % 3600) / 60)}m`;
 }
 
+// left-padded label + white value — used inside the box
+function row(label, value) {
+  return chalk.dim(`  ${label.padEnd(13)}`) + chalk.white(value);
+}
+
+// ─── boxen options ────────────────────────────────────────────────────────────
+
+const BOX_OPTS = {
+  padding:     { top: 0, bottom: 0, left: 1, right: 2 },
+  borderStyle: 'round',
+  borderColor: TEAL,
+};
+
+const BOX_OPTS_PINK = {
+  padding:     { top: 0, bottom: 0, left: 1, right: 2 },
+  borderStyle: 'round',
+  borderColor: PINK,
+};
+
+// ─── main ─────────────────────────────────────────────────────────────────────
+
 export async function status() {
   if (!(await globalConfigExists())) {
     print.gap();
@@ -32,63 +57,82 @@ export async function status() {
     return;
   }
 
-  const pid = await getLivePid();
-  const state = await readState();
+  const pid    = await getLivePid();
+  const state  = await readState();
   const config = await loadGlobalConfig();
 
   print.gap();
 
+  // ── not running ─────────────────────────────────────────────────────────────
+
   if (!pid) {
     if (state.status === STATE.PAUSED) {
-      print.brand('gitwrit is paused.');
-      print.gap();
-      print.info(`Resumed from sleep — last active ${timeAgo(state.pausedAt)}.`);
-      print.gap();
-      print.hint('Run gitwrit start to resume watching.');
+      const lines = [
+        '',
+        chalk.hex(PINK).bold('  gitwrit is paused.'),
+        '',
+        chalk.dim(`  Last active ${timeAgo(state.pausedAt)}.`),
+        chalk.dim('  Run gitwrit start to resume watching.'),
+        '',
+      ];
+      console.log(boxen(lines.join('\n'), BOX_OPTS_PINK));
     } else {
-      print.brand('gitwrit is not running.');
-      print.hint('Run gitwrit start to begin watching.');
+      const lines = [
+        '',
+        chalk.dim('  gitwrit is not running.'),
+        '',
+        chalk.dim('  Run gitwrit start to begin watching.'),
+        '',
+      ];
+      console.log(boxen(lines.join('\n'), { ...BOX_OPTS, borderColor: 'gray' }));
     }
     print.gap();
     return;
   }
 
+  // ── running ──────────────────────────────────────────────────────────────────
+
   const resumedAfterSleep = state.resumedAt &&
     (Date.now() - new Date(state.resumedAt)) < 60000;
 
+  const lines = [''];
+
   if (resumedAfterSleep) {
-    print.brand('gitwrit is running — resumed after sleep.');
+    lines.push(chalk.hex(TEAL).bold('  gitwrit is running') + chalk.dim(' — resumed after sleep.'));
   } else {
-    print.brand('gitwrit is running.');
+    lines.push(chalk.hex(TEAL).bold('  gitwrit is running.'));
   }
 
-  print.gap();
-  print.row('Uptime',      formatUptime(state.startedAt));
-  print.row('Watching',    config.watch.map(w => w.path).join(', '));
+  lines.push('');
+  lines.push(row('Uptime',   formatUptime(state.startedAt)));
+  lines.push(row('Watching', config.watch.map(w => w.path).join(', ')));
 
   if (state.sessionBranch) {
-    print.row('Branch', state.sessionBranch, 'autogenerated');
+    lines.push(row('Branch', state.sessionBranch) + chalk.hex(PINK).dim(' (autogenerated)'));
   } else {
-    print.row('Branch', 'Current branch');
+    lines.push(row('Branch', 'Current branch'));
   }
 
   if (state.sessionCommits > 0) {
-    print.row('Commits', `${state.sessionCommits} this session`);
+    lines.push(row('Commits', `${state.sessionCommits} this session`));
   }
 
   if (state.lastCommittedAt) {
     const fileLabel = state.lastCommittedFile ? `  (${state.lastCommittedFile})` : '';
-    print.row('Last commit', `${timeAgo(state.lastCommittedAt)}${fileLabel}`);
+    lines.push(row('Last commit', `${timeAgo(state.lastCommittedAt)}${fileLabel}`));
   }
 
   if (state.lastPushedAt) {
-    print.row('Last push', timeAgo(state.lastPushedAt));
+    lines.push(row('Last push', timeAgo(state.lastPushedAt)));
   }
 
   if (resumedAfterSleep && state.catchUpCommits > 0) {
-    print.gap();
-    print.good(`${state.catchUpCommits} file${state.catchUpCommits !== 1 ? 's' : ''} committed on wake.`);
+    lines.push('');
+    lines.push(chalk.hex(TEAL)(`  ✔  ${state.catchUpCommits} file${state.catchUpCommits !== 1 ? 's' : ''} committed on wake.`));
   }
 
+  lines.push('');
+
+  console.log(boxen(lines.join('\n'), BOX_OPTS));
   print.gap();
-}
+}