Merge pull request #15 from clidey/claude/issue-14-20250623_044710

feat: add dory CLI tool with build and preview commands

Author: hkdeman

README.md

@@ -38,7 +38,49 @@ Dory is:
 
 ---
 
-## 🧑‍💻 Quick Start
+## 📦 CLI Installation
+
+Install Dory globally to use the CLI tool:
+
+```bash
+npm install -g dory
+```
+
+### CLI Usage
+
+Once installed, you can use the `dory` command:
+
+#### `dory build`
+Builds your documentation site:
+- Checks for `dory.json` in current directory
+- Clears and prepares the `docs` folder
+- Copies configuration to `docs` folder
+- Runs the build process
+- Creates `dist` folder with build output
+
+```bash
+dory build
+```
+
+#### `dory preview`
+Previews the built documentation site:
+- Requires `dist` folder (run `dory build` first)
+- Starts a local preview server
+
+```bash
+dory preview
+```
+
+#### `dory help`
+Shows CLI usage information:
+
+```bash
+dory help
+```
+
+---
+
+## 🧑‍💻 Development Setup
 
 Follow these steps to set up and preview the documentation locally, as well as build a static site for deployment.
 

bin/dory.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+
+import { execSync } from 'child_process';
+import { existsSync, rmSync, mkdirSync, cpSync, readFileSync } from 'fs';
+import { resolve, dirname } from 'path';
+import { fileURLToPath } from 'url'
+import http from 'http';
+import sirv from 'sirv';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const commands = {
+  build: () => {
+    console.log('🏗️  Starting Dory build...');
+    
+    // Check if dory.json exists in current directory
+    const currentDir = process.cwd();
+    const doryConfigPath = resolve(currentDir, 'dory.json');
+    
+    if (!existsSync(doryConfigPath)) {
+      console.error('❌ dory.json not found in current directory');
+      process.exit(1);
+    }
+    
+    // Read and validate dory.json
+    try {
+      const config = JSON.parse(readFileSync(doryConfigPath, 'utf8'));
+      console.log(`📋 Using config: ${config.name || 'Unnamed project'}`);
+    } catch (error) {
+      console.error('❌ Invalid dory.json file:', error.message);
+      process.exit(1);
+    }
+    
+    // Clear and prepare docs folder
+    const docsDir = resolve(currentDir, 'docs');
+    if (existsSync(docsDir)) {
+      console.log('🧹 Clearing docs folder...');
+      rmSync(docsDir, { recursive: true, force: true });
+    }
+    mkdirSync(docsDir, { recursive: true });
+    
+    // Copy dory.json to docs folder
+    cpSync(doryConfigPath, resolve(docsDir, 'dory.json'));
+    console.log('📄 Copied dory.json to docs folder');
+    
+    // Run the build command
+    console.log('⚡ Running build command...');
+    try {
+      execSync('npm run build', { stdio: 'inherit', cwd: __dirname });
+    } catch (error) {
+      console.error('❌ Build failed:', error.message);
+      process.exit(1);
+    }
+    
+    // Check if dist folder was created
+    const distDir = resolve(__dirname, '..', 'dist');
+    if (existsSync(distDir)) {
+      console.log('✅ Build completed successfully!');
+      console.log(`📦 Build output available in: ${distDir}`);
+      console.log('📋 Moving build output to current directory...');
+      cpSync(distDir, resolve(currentDir, 'dist'), { recursive: true });
+      console.log(`📦 Build output moved to: ${resolve(currentDir, 'dist')}`);
+    } else {
+      console.log('⚠️  Build completed but no dist folder found');
+    }
+    rmSync(distDir, { recursive: true, force: true });
+  },
+
+  preview: () => {
+    console.log('👀 Starting Dory preview...');
+    const currentDir = process.cwd();
+    const distDir = resolve(currentDir, 'dist');
+    const port = process.env.PORT || 3000;
+
+    const serve = sirv(distDir, {
+      dev: false,
+      single: true,
+      etag: true,
+      gzip: true,
+      brotli: true,
+    });
+
+    const server = http.createServer((req, res) => {
+      serve(req, res);
+    });
+
+    server.listen(port, () => {
+      console.log(`🚀 Serving Dory at http://localhost:${port}`);
+    });
+  },
+
+  help: () => {
+    console.log(`
+🐟 Dory CLI - Documentation Build Tool
+
+Usage:
+  dory <command>
+
+Commands:
+  build     Build the documentation site
+            - Requires dory.json in current directory
+            - Clears and copies to docs folder
+            - Runs build command
+            - Creates dist folder with build output
+            
+  preview   Preview the built documentation site
+            - Requires dist folder (run build first)
+            - Starts preview server
+            
+  help      Show this help message
+
+Examples:
+  dory build    # Build the documentation
+  dory preview  # Preview the built site
+`);
+  }
+};
+
+// Parse command line arguments
+const command = process.argv[2];
+
+if (!command || command === 'help' || command === '--help' || command === '-h') {
+  commands.help();
+} else if (commands[command]) {
+  commands[command]();
+} else {
+  console.error(`❌ Unknown command: ${command}`);
+  console.log('Run "dory help" for usage information');
+  process.exit(1);
+}

package.json

@@ -1,8 +1,29 @@
 {
-  "name": "doc-engine-v2",
-  "private": true,
-  "version": "0.0.0",
+  "name": "@clidey/dory",
+  "private": false,
+  "version": "1.0.0",
   "type": "module",
+  "description": "A CLI tool for building and previewing documentation sites",
+  "keywords": [
+    "cli",
+    "documentation",
+    "build",
+    "preview",
+    "static-site"
+  ],
+  "bin": {
+    "dory": "./bin/dory.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/clidey/dory.git"
+  },
+  "author": "Clidey",
+  "license": "MIT",
+  "homepage": "https://github.com/clidey/dory",
+  "bugs": {
+    "url": "https://github.com/clidey/dory/issues"
+  },
   "scripts": {
     "dev": "vite",
     "build": "tsc -b && vite build",
@@ -32,6 +53,7 @@
     "react-highlight-words": "^0.21.0",
     "remark-gfm": "^4.0.1",
     "saas": "^1.0.0",
+    "sirv": "^3.0.1",
     "tailwindcss": "^4.1.8",
     "unist-util-visit": "^5.0.0",
     "vite-plugin-mdx": "^3.6.1",