gyrus 0.1.0 → 0.1.2

package/README.md

@@ -1,7 +1,7 @@
 # Gyrus
 
-[![CI](https://github.com/evgenii-polyakun/gyrus/actions/workflows/ci.yml/badge.svg)](https://github.com/evgenii-polyakun/gyrus/actions/workflows/ci.yml)
-[![Release](https://github.com/evgenii-polyakun/gyrus/actions/workflows/release.yml/badge.svg)](https://github.com/evgenii-polyakun/gyrus/actions/workflows/release.yml)
+[![CI](https://github.com/ewgenius/gyrus/actions/workflows/ci.yml/badge.svg)](https://github.com/ewgenius/gyrus/actions/workflows/ci.yml)
+[![Release](https://github.com/ewgenius/gyrus/actions/workflows/release.yml/badge.svg)](https://github.com/ewgenius/gyrus/actions/workflows/release.yml)
 [![npm version](https://img.shields.io/npm/v/gyrus.svg)](https://www.npmjs.com/package/gyrus)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Bun](https://img.shields.io/badge/Bun-%3E%3D1.0.0-black)](https://bun.sh)
@@ -26,7 +26,7 @@ Gyrus is a unified CLI tool for managing knowledge notes and Architecture Decisi
 
 ```bash
 # Clone the repository
-git clone https://github.com/evgenii-polyakun/gyrus.git
+git clone https://github.com/ewgenius/gyrus.git
 cd gyrus
 
 # Install dependencies
@@ -75,6 +75,10 @@ gyrus use work
 | `gyrus use <name>` | Set the default workspace |
 | `gyrus doctor` | Run diagnostics and health check |
 | `gyrus mcp` | Start the MCP server (stdio) |
+| `gyrus sync` | Stage and commit all changes to git |
+| `gyrus push` | Push commits to remote |
+| `gyrus pull` | Pull latest from remote |
+| `gyrus completions <shell>` | Generate shell completions (bash, zsh, fish) |
 | `gyrus serve` | Start the dashboard server (coming soon) |
 | `gyrus daemon` | Start HTTP/SSE MCP server (coming soon) |
 
@@ -94,6 +98,124 @@ gyrus doctor --workspace work
 gyrus doctor --all
 ```
 
+## Git Sync
+
+Gyrus integrates with git to backup and sync your knowledge across machines.
+
+### Commands
+
+```bash
+# Stage and commit all changes
+gyrus sync
+
+# Commit with custom message
+gyrus sync -m "Add authentication patterns"
+
+# Sync and push in one command
+gyrus sync --push
+
+# Push committed changes
+gyrus push
+
+# Pull latest changes
+gyrus pull
+
+# Pull with auto-stash (saves local changes, pulls, restores)
+gyrus pull --stash
+
+# Sync all workspaces at once
+gyrus sync --all
+gyrus push --all
+gyrus pull --all
+
+# Preview what would be committed
+gyrus sync --dry-run
+
+# Verbose output
+gyrus sync -v
+```
+
+### Configuration
+
+Add git settings to workspace config in `~/.config/gyrus/config.json`:
+
+```json
+{
+  "workspaces": [
+    {
+      "name": "personal",
+      "path": "~/gyrus",
+      "description": "Personal knowledge",
+      "git": {
+        "enabled": true,
+        "autoSync": false,
+        "autoPush": false,
+        "commitPrefix": "gyrus:",
+        "defaultBranch": "main"
+      }
+    }
+  ]
+}
+```
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| `enabled` | `true` | Enable git integration (auto-detected if .git exists) |
+| `autoSync` | `false` | Auto-commit after create/update operations |
+| `autoPush` | `false` | Auto-push after sync |
+| `commitPrefix` | `"gyrus:"` | Prefix for auto-generated commit messages |
+| `defaultBranch` | `"main"` | Default branch for operations |
+
+### Auto-Generated Commit Messages
+
+When you run `gyrus sync` without a message, it generates:
+
+```
+gyrus: sync knowledge and ADRs - 2026-01-15 15:30
+```
+
+## Shell Completions
+
+Gyrus provides shell completions for bash, zsh, and fish.
+
+### Bash
+
+Add to your `~/.bashrc`:
+
+```bash
+eval "$(gyrus completions bash)"
+```
+
+Or save to completion directory:
+
+```bash
+gyrus completions bash > ~/.local/share/bash-completion/completions/gyrus
+```
+
+### Zsh
+
+Add to your `~/.zshrc`:
+
+```bash
+eval "$(gyrus completions zsh)"
+```
+
+Or save to completions directory (ensure the directory is in your fpath):
+
+```bash
+mkdir -p ~/.zsh/completions
+gyrus completions zsh > ~/.zsh/completions/_gyrus
+# Add to ~/.zshrc: fpath=(~/.zsh/completions $fpath)
+```
+
+### Fish
+
+Save to fish completions directory:
+
+```bash
+gyrus completions fish > ~/.config/fish/completions/gyrus.fish
+```
+
 ## MCP Integration
 
 ### Claude Desktop Configuration
@@ -104,8 +226,8 @@ Add to your Claude Desktop config (`~/Library/Application Support/Claude/claude_
 {
   "mcpServers": {
     "gyrus": {
-      "command": "bun",
-      "args": ["run", "/path/to/gyrus/src/index.ts", "mcp"]
+      "command": "gyrus",
+      "args": ["mcp"]
     }
   }
 }
@@ -117,7 +239,7 @@ Or using the compiled binary:
 {
   "mcpServers": {
     "gyrus": {
-      "command": "/path/to/gyrus/dist/gyrus",
+      "command": "gyrus",
       "args": ["mcp"]
     }
   }
@@ -270,4 +392,4 @@ working_folder: /path/to/project
 
 ## License
 
-MIT
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gyrus",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Model-agnostic knowledge management CLI with MCP server support",
   "type": "module",
   "bin": {
@@ -22,12 +22,15 @@
     "build:macos": "bun build src/index.ts --compile --target=bun-darwin-arm64 --outfile dist/gyrus-darwin-arm64 && bun build src/index.ts --compile --target=bun-darwin-x64 --outfile dist/gyrus-darwin-x64",
     "build:linux": "bun build src/index.ts --compile --target=bun-linux-x64 --outfile dist/gyrus-linux-x64 && bun build src/index.ts --compile --target=bun-linux-arm64 --outfile dist/gyrus-linux-arm64",
     "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
+    "test": "bun test",
+    "test:watch": "bun test --watch",
+    "test:coverage": "bun test --coverage",
     "doctor": "bun run src/index.ts doctor",
     "mcp": "bun run src/index.ts mcp",
-    "prepublishOnly": "bun run typecheck && bun run test"
+    "prepublishOnly": "bun run typecheck && bun run test",
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview"
   },
   "keywords": [
     "knowledge-management",
@@ -47,12 +50,12 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/evgenii-polyakun/gyrus.git"
+    "url": "git+https://github.com/ewgenius/gyrus.git"
   },
   "bugs": {
-    "url": "https://github.com/evgenii-polyakun/gyrus/issues"
+    "url": "https://github.com/ewgenius/gyrus/issues"
   },
-  "homepage": "https://github.com/evgenii-polyakun/gyrus#readme",
+  "homepage": "https://github.com/ewgenius/gyrus#readme",
   "engines": {
     "bun": ">=1.0.0"
   },
@@ -73,6 +76,6 @@
     "@types/bun": "latest",
     "prettier": "^3.8.0",
     "typescript": "^5",
-    "vitest": "^4.0.17"
+    "vitepress": "^2.0.0-alpha.15"
   }
 }