doc-syncer 0.1.0 → 0.1.1

package/README.md

@@ -6,23 +6,17 @@ AI-powered documentation sync using Claude Code or Codex.
 Code changes (PR/branch) → Agent analyzes → Docs updated
 ```
 
-## Install
-
-### Via npm (recommended)
+## Prerequisites
 
-```bash
-npm install -g doc-syncer
-```
+### 1. Install Bun
 
-### From source
+This package requires Bun runtime:
 
 ```bash
-git clone https://github.com/orlan0045/doc-syncer.git
-cd doc-syncer
-bun install
+curl -fsSL https://bun.sh/install | bash
 ```
 
-## Prerequisites
+### 2. Install an AI agent
 
 You need one of these AI agents installed:
 
@@ -35,13 +29,35 @@ claude  # authenticate once
 # Follow Codex CLI installation instructions
 ```
 
+## Install
+
+### Via Bun (recommended)
+
+```bash
+bun install -g doc-syncer
+```
+
+### Via npm
+
+```bash
+npm install -g doc-syncer
+```
+
+### From source
+
+```bash
+git clone https://github.com/orlan0045/doc-syncer.git
+cd doc-syncer
+bun install
+```
+
 ## Setup
 
-Download the example config and customize it:
+Create your configuration file:
 
 ```bash
-# Download example config
-curl -o doc-syncer.config.yml https://raw.githubusercontent.com/orlan0045/doc-syncer/main/doc-syncer.config.example.yml
+# Create config from example
+doc-syncer init
 
 # Edit with your repo paths
 nano doc-syncer.config.yml
@@ -64,9 +80,12 @@ modes:
 
 ### Option 1: Config file (recommended)
 
-Run:
-
 ```bash
+# First time setup
+doc-syncer init                 # create config file
+# Edit doc-syncer.config.yml with your paths
+
+# Then run
 doc-syncer sync                 # run it
 doc-syncer sync --dry-run       # preview only
 doc-syncer sync --mode backend  # use specific mode from config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-syncer",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "AI-powered documentation sync using Claude Code or Codex",
   "type": "module",
   "author": "Andrii Orlov",
@@ -29,6 +29,7 @@
   "files": [
     "src/",
     "doc-syncer.config.example.yml",
+    "tsconfig.json",
     "README.md",
     "LICENSE"
   ],
@@ -42,6 +43,9 @@
     "yaml": "^2.6.0"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "bun": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.5"
   }
 }

package/src/cli.ts

@@ -4,10 +4,14 @@
  * doc-syncer CLI entry point
  *
  * Usage:
+ *   doc-syncer init
  *   doc-syncer sync [options]
  *   doc-syncer --help
  */
 
+import { join } from "node:path";
+import { existsSync, copyFileSync } from "node:fs";
+
 const args = Bun.argv.slice(2);
 const command = args[0];
 
@@ -16,7 +20,9 @@ if (!command || command === "--help" || command === "-h") {
   process.exit(0);
 }
 
-if (command === "sync") {
+if (command === "init") {
+  handleInit();
+} else if (command === "sync") {
   // Remove 'sync' from args and run the sync script
   Bun.argv.splice(2, 1);
   await import("./doc-sync.ts");
@@ -26,14 +32,46 @@ if (command === "sync") {
   process.exit(1);
 }
 
+function handleInit() {
+  const targetFile = join(process.cwd(), "doc-syncer.config.yml");
+
+  // Check if config already exists
+  if (existsSync(targetFile)) {
+    console.error("❌ Config file already exists: doc-syncer.config.yml");
+    console.log("   Delete it first or edit it directly");
+    process.exit(1);
+  }
+
+  // Find the example config file (relative to this script)
+  const exampleFile = join(import.meta.dir, "..", "doc-syncer.config.example.yml");
+
+  if (!existsSync(exampleFile)) {
+    console.error("❌ Example config file not found");
+    console.log("   Expected at:", exampleFile);
+    process.exit(1);
+  }
+
+  // Copy the example config
+  try {
+    copyFileSync(exampleFile, targetFile);
+    console.log("✅ Created doc-syncer.config.yml");
+    console.log("   Edit this file with your repository paths");
+  } catch (error) {
+    console.error("❌ Failed to create config file:", error.message);
+    process.exit(1);
+  }
+}
+
 function printHelp() {
   console.log(`
 doc-syncer: AI-powered documentation sync
 
 Usage:
+  doc-syncer init
   doc-syncer sync [options]
 
 Commands:
+  init          Create doc-syncer.config.yml from example
   sync          Sync documentation based on code changes
 
 Options:
@@ -48,6 +86,7 @@ Options:
   -h, --help        Show this help
 
 Examples:
+  doc-syncer init                           # Create config file
   doc-syncer sync                           # Use default mode
   doc-syncer sync --mode esign              # Use specific mode
   doc-syncer sync --mode esign --dry-run    # Preview mode

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+    "moduleDetection": "force",
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "composite": true,
+    "strict": true,
+    "downlevelIteration": true,
+    "skipLibCheck": true,
+    "jsx": "react-jsx",
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "types": [
+      "bun-types"
+    ]
+  }
+}