@ork-sh/cli 0.1.5 → 0.1.8

package/README.md

@@ -0,0 +1,124 @@
+# Ork
+
+> Orchestrate your AI agents from the command line (in Beta)
+
+`ork` is a CLI toolkit that helps you discover, manage, and interact with AI agents installed on your system. It provides both an interactive TUI (Terminal User Interface) and command-line tools to detect and work with popular AI CLI tools like Claude, Gemini, and more.
+
+
+## Installation
+
+```bash
+npm install -g @ork-sh/cli
+```
+
+## What Can You Do With ork?
+
+`ork` provides a suite of AI-powered commands to help you with your development workflow:
+
+### `/plan` - Project Planning
+Generate detailed implementation plans for your projects. ork will create a comprehensive `plan.md` file with:
+- Project overview and objectives
+- Step-by-step implementation guide
+- Required technologies and dependencies
+- File structure recommendations
+- Code examples and best practices
+- Potential challenges and solutions
+
+**Usage:** `/plan <describe your project>`
+
+### `/init` - Project Analysis
+Analyze your entire codebase and generate comprehensive documentation. Creates an `agents.md` file containing:
+- Project overview and main purpose
+- Core functionality and features
+- Architecture and component relationships
+- File structure breakdown
+- Technologies, frameworks, and libraries used
+- Setup and run instructions
+- Key concepts and patterns
+
+**Usage:** `/init`
+
+### `/audit` - Code Audit
+Get a thorough AI-powered audit of your codebase. Results are saved to `audit.md` with insights on:
+- Code quality and best practices
+- Security vulnerabilities
+- Performance issues
+- Technical debt
+- Improvement recommendations
+
+**Usage:** `/audit <what to audit>`
+
+### `/review` - Code Review
+Request an AI code review for specific files or features. Review results saved to `review.md` include:
+- Code structure analysis
+- Logic and algorithm review
+- Style and convention feedback
+- Bug detection
+- Optimization suggestions
+
+**Usage:** `/review <what to review>`
+
+### `/refactor` - Refactoring Suggestions
+Get intelligent refactoring recommendations. Suggestions saved to `refactor.md` cover:
+- Code organization improvements
+- Design pattern applications
+- Performance optimizations
+- Maintainability enhancements
+- Modern syntax updates
+
+**Usage:** `/refactor <what to refactor>`
+
+### `/explain` - Code Explanation
+Get detailed explanations of code or concepts. Explanations saved to `explain.md` help you understand:
+- How specific code works
+- Complex algorithms and logic
+- Framework or library usage
+- Design patterns and architectures
+- Technical concepts
+
+**Usage:** `/explain <what to explain>`
+
+### `/commit` - Smart Git Commits
+Save your changes with AI-assisted commit messages that follow best practices.
+
+**Usage:** `/commit`
+
+### `/revert` - Version Control
+Browse your commit history and restore previous versions of your project with an interactive picker.
+
+**Usage:** `/revert`
+
+### `/ask` - Quick Questions
+Ask questions and get answers from ChatGPT or Google.
+
+**Usage:** `/ask <your question>`
+
+### `/agents` - Manage AI Agents
+Detect and manage AI CLI tools installed on your system (Claude, Gemini, Copilot, Codex).
+
+**Usage:** `/agents`
+
+
+## Getting Started
+
+1. Install ork globally:
+   ```bash
+   npm install -g @ork-sh/cli
+   ```
+
+2. Launch the interactive TUI:
+   ```bash
+   ork
+   ```
+
+3. Type any slash command (e.g., `/plan`, `/audit`) and follow the prompts
+
+4. Your AI-generated results will be saved as markdown files in your current directory
+
+## Requirements
+
+- Node.js >= 14.0.0
+- At least one AI agent installed (Claude, Codex, Copilot, or Gemini)
+- macOS, Linux, or Windows
+
+

package/bin/index.js

@@ -14,8 +14,10 @@ if (platform === 'darwin') {
     } else {
         binaryName = 'ork-darwin-amd64';
     }
+} else if (platform === 'win32') {
+    binaryName = 'ork-windows-amd64.exe';
 } else {
-    process.stderr.write('Error: Currently, @ork-sh/cli only supports macOS.\n');
+    process.stderr.write(`Error: Currently, @ork-sh/cli only supports macOS and Windows. Found platform: ${platform}\n`);
     process.exit(1);
 }
 

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@ork-sh/cli",
-  "version": "0.1.5",
-  "description": "Orchestrate your AI",
+  "version": "0.1.8",
+  "description": "Orchestrate your agents",
   "main": "index.js",
   "files": [
-    "bin"
+    "bin",
+    "README.md"
   ],
   "bin": {
     "ork": "bin/index.js"
   },
   "scripts": {
-    "postinstall": "chmod +x bin/index.js bin/ork-darwin-amd64 bin/ork-darwin-arm64"
+    "postinstall": "node -e \"if(process.platform !== 'win32') require('child_process').execSync('chmod +x bin/index.js bin/ork-darwin-amd64 bin/ork-darwin-arm64')\""
   },
   "keywords": [
     "ai",