specchain-pro 0.1.0

package/README.md

@@ -0,0 +1,264 @@
+# SpecChain Pro
+
+> AI-powered specification generation with blockchain proof-of-authorship
+
+[![Version](https://img.shields.io/badge/version-0.1.0-blue.svg)](https://github.com/yourusername/specchain-pro)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![Node](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org)
+
+## 🚀 Quick Start
+
+```bash
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run in development mode
+npm run dev -- new "Your idea here"
+
+# Run tests
+npm test
+```
+
+## 📋 Features
+
+### MVP (Current Phase)
+- ✅ Project structure and configuration
+- 🚧 AI-powered spec generation (in progress)
+- 🚧 Blockchain proof-of-authorship (in progress)
+- 🚧 Cryptographic verification (in progress)
+- 🚧 CLI interface (in progress)
+- 🚧 Local storage (in progress)
+
+### Coming Soon
+- Remix system with attribution
+- Public feed for spec discovery
+- Export to multiple formats
+- Local AI support for offline operation
+- Web application interface
+
+## 🛠️ Installation
+
+### Prerequisites
+- Node.js >= 18.0.0
+- npm or yarn
+
+### Option 1: Install from GitHub (Recommended)
+
+```bash
+npm install -g github:yourusername/specchain-pro
+```
+
+### Option 2: Install from Source
+
+```bash
+git clone https://github.com/yourusername/specchain-pro.git
+cd specchain-pro
+npm install
+npm run build
+npm link  # Make 'spec' command available globally
+```
+
+### Option 3: Install from npm (When Published)
+
+```bash
+npm install -g specchain-pro
+```
+
+> **Note**: npm publishing is optional. See [DEPLOY_WITHOUT_NPM.md](DEPLOY_WITHOUT_NPM.md) for alternative deployment methods.
+
+## 📖 Usage
+
+### Generate a new specification
+
+```bash
+spec new "Build a real-time chat application with WebRTC"
+```
+
+### Sign a specification (create blockchain proof)
+
+```bash
+spec sign spec-123
+```
+
+### Verify a specification
+
+```bash
+spec verify spec-123
+```
+
+### List all specifications
+
+```bash
+spec list
+spec list --tags "web,api"
+spec list --author "0xYourAddress"
+```
+
+### Export a specification
+
+```bash
+spec export spec-123 markdown
+spec export spec-123 json --output ./my-spec.json
+spec export spec-123 github
+```
+
+### Manage configuration
+
+```bash
+spec config show
+spec config set --key ai.provider --value openai
+```
+
+## ⚙️ Configuration
+
+Configuration is stored in `~/.specchain/config.json`. You can edit it manually or use the CLI:
+
+```json
+{
+  "ai": {
+    "provider": "openai",
+    "model": "gpt-4",
+    "temperature": 0.7,
+    "maxTokens": 2000
+  },
+  "blockchain": {
+    "network": "testnet",
+    "rpcUrl": "https://sepolia.infura.io/v3/YOUR_KEY",
+    "contractAddress": "0x...",
+    "gasLimit": 500000
+  },
+  "storage": {
+    "basePath": "~/.specchain",
+    "maxVersionHistory": 50
+  }
+}
+```
+
+### Environment Variables
+
+You can override configuration with environment variables:
+
+```bash
+export OPENAI_API_KEY="your-api-key"
+export BLOCKCHAIN_RPC_URL="https://your-rpc-url"
+export CONTRACT_ADDRESS="0x..."
+```
+
+## 🧪 Development
+
+### Project Structure
+
+```
+specchain-pro/
+├── src/
+│   ├── cli/           # CLI interface
+│   ├── core/          # Core orchestration
+│   ├── ai/            # AI spec engine
+│   ├── blockchain/    # Blockchain proof layer
+│   ├── storage/       # Local storage
+│   ├── export/        # Export system
+│   ├── utils/         # Utilities
+│   └── types/         # TypeScript types
+├── dist/              # Compiled output
+├── tests/             # Test files
+└── docs/              # Documentation
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run with coverage
+npm test -- --coverage
+```
+
+### Linting and Formatting
+
+```bash
+# Lint code
+npm run lint
+
+# Format code
+npm run format
+```
+
+## 📚 Documentation
+
+- [Problem Statement](.kiro/specs/specchain-pro/problem-statement.md)
+- [Solution Proposal](.kiro/specs/specchain-pro/solution-proposal.md)
+- [Product Roadmap](.kiro/specs/specchain-pro/roadmap.md)
+- [Requirements](.kiro/specs/specchain-pro/requirements.md)
+- [Design Document](.kiro/specs/specchain-pro/design.md)
+- [Implementation Tasks](.kiro/specs/specchain-pro/tasks.md)
+
+## 🗺️ Roadmap
+
+### Phase 1: MVP (Months 1-4) - Current
+- [x] Project setup and infrastructure
+- [ ] Local storage layer
+- [ ] Cryptographic hashing
+- [ ] Blockchain proof layer
+- [ ] AI spec engine
+- [ ] CLI interface
+- [ ] Export system
+
+### Phase 2: Growth (Months 5-8)
+- [ ] Remix and lineage system
+- [ ] Public feed layer
+- [ ] Local AI support
+- [ ] Layer 2 optimization
+
+### Phase 3: Web App (Months 9-12)
+- [ ] React web application
+- [ ] Wallet integration
+- [ ] Visual spec creation
+- [ ] Public feed browsing
+
+### Phase 4: Scale (Months 13-18)
+- [ ] Team collaboration
+- [ ] Third-party integrations
+- [ ] Enterprise features
+- [ ] Community ecosystem
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- OpenAI for GPT-4 API
+- Ethereum and Layer 2 communities
+- All contributors and supporters
+
+## 📞 Support
+
+- Documentation: [docs/](docs/)
+- Issues: [GitHub Issues](https://github.com/yourusername/specchain-pro/issues)
+- Discussions: [GitHub Discussions](https://github.com/yourusername/specchain-pro/discussions)
+
+---
+
+**Status:** 🚧 MVP Development in Progress
+
+**Version:** 0.1.0 (Alpha)
+
+**Last Updated:** January 2025
+"# specchain-pro" 

package/YOUR_DEPLOYMENT_CHECKLIST.md

@@ -0,0 +1,268 @@
+# Your Deployment Checklist - luxmikant/specchain-pro
+
+## ✅ Pre-Deployment (Already Done!)
+
+- [x] package.json updated with your info
+  - Author: Luxmikant <luxmikant@outlook.com>
+  - Repository: https://github.com/luxmikant/specchain-pro.git
+- [x] Project structure created
+- [x] All documentation ready
+- [x] Build system configured
+
+---
+
+## 🚀 Deploy to GitHub (5 minutes)
+
+### Option 1: Automated Script (Recommended)
+
+```bash
+# Windows
+.\setup-git.ps1
+
+# Linux/Mac
+chmod +x setup-git.sh
+./setup-git.sh
+```
+
+### Option 2: Manual Commands
+
+```bash
+# 1. Initialize git
+git init
+
+# 2. Add all files
+git add .
+
+# 3. Create initial commit
+git commit -m "Initial commit: SpecChain Pro v0.1.0 MVP base"
+
+# 4. Set main branch
+git branch -M main
+
+# 5. Add remote
+git remote add origin https://github.com/luxmikant/specchain-pro.git
+
+# 6. Push to GitHub
+git push -u origin main
+
+# 7. Create release tag
+git tag -a v0.1.0 -m "Release v0.1.0: MVP Base Foundation"
+git push origin v0.1.0
+```
+
+---
+
+## 📦 Publish to npm (10 minutes)
+
+### Step 1: Create npm Account (if needed)
+
+Go to: https://www.npmjs.com/signup
+
+Or use CLI:
+```bash
+npm adduser
+```
+
+### Step 2: Login
+
+```bash
+npm login
+# Enter your npm username, password, and email
+# Email: luxmikant@outlook.com
+
+# Verify
+npm whoami
+```
+
+### Step 3: Build
+
+```bash
+npm run build
+```
+
+### Step 4: Test Locally
+
+```bash
+npm link
+spec --version
+spec --help
+npm unlink -g specchain-pro
+```
+
+### Step 5: Dry Run
+
+```bash
+npm publish --dry-run
+```
+
+### Step 6: Publish!
+
+```bash
+npm publish
+```
+
+### Step 7: Verify
+
+```bash
+npm view specchain-pro
+```
+
+Visit: https://www.npmjs.com/package/specchain-pro
+
+---
+
+## 🎯 Post-Deployment
+
+### Create GitHub Release
+
+1. Go to: https://github.com/luxmikant/specchain-pro/releases/new
+2. Select tag: `v0.1.0`
+3. Title: `v0.1.0 - MVP Base Foundation`
+4. Description:
+
+```markdown
+## 🎉 SpecChain Pro v0.1.0 - MVP Base Foundation
+
+First release! Now available on npm.
+
+### 📦 Installation
+
+```bash
+npm install -g specchain-pro
+```
+
+### ✅ Features
+- Complete project infrastructure
+- CLI interface with 6 commands
+- Configuration management
+- Error handling and logging
+- Comprehensive documentation
+
+### 🚧 Coming Soon
+- Local storage layer
+- Blockchain proof layer
+- AI spec engine
+
+### 🔗 Links
+- npm: https://www.npmjs.com/package/specchain-pro
+- GitHub: https://github.com/luxmikant/specchain-pro
+```
+
+5. Click "Publish release"
+
+---
+
+## 📢 Announce Your Project
+
+### Twitter/X
+```
+🚀 Just published SpecChain Pro v0.1.0 to npm!
+
+AI-powered specification generation with blockchain proof-of-authorship.
+
+Install: npm install -g specchain-pro
+
+✨ Transform ideas into structured specs
+🔐 Blockchain-based proof of ownership
+⚡ CLI-first developer experience
+
+#opensource #nodejs #blockchain #ai
+
+https://www.npmjs.com/package/specchain-pro
+https://github.com/luxmikant/specchain-pro
+```
+
+### Reddit
+- r/node
+- r/programming
+- r/javascript
+- r/opensource
+
+### Dev.to
+Write a launch post about your project
+
+---
+
+## 🔄 Future Updates
+
+When you add new features:
+
+```bash
+# 1. Make changes and build
+npm run build
+
+# 2. Update version
+npm version patch  # 0.1.0 → 0.1.1
+npm version minor  # 0.1.0 → 0.2.0
+npm version major  # 0.1.0 → 1.0.0
+
+# 3. Publish
+npm publish
+
+# 4. Push to GitHub
+git push && git push --tags
+```
+
+Or use automated script:
+```bash
+# Windows
+.\scripts\deploy.ps1
+
+# Linux/Mac
+./scripts/deploy.sh
+```
+
+---
+
+## 📊 Monitor Your Package
+
+### npm
+- Package: https://www.npmjs.com/package/specchain-pro
+- Stats: https://npm-stat.com/charts.html?package=specchain-pro
+
+### GitHub
+- Repository: https://github.com/luxmikant/specchain-pro
+- Issues: https://github.com/luxmikant/specchain-pro/issues
+- Stars: Track your growth!
+
+---
+
+## ✅ Final Checklist
+
+- [ ] GitHub repository created
+- [ ] Code pushed to GitHub
+- [ ] Release tag created (v0.1.0)
+- [ ] npm account created
+- [ ] Logged in to npm
+- [ ] Package published to npm
+- [ ] GitHub release created
+- [ ] Installation tested
+- [ ] Announced on social media
+
+---
+
+## 🎉 You're Live!
+
+Once completed, your package will be available at:
+
+- **npm**: https://www.npmjs.com/package/specchain-pro
+- **GitHub**: https://github.com/luxmikant/specchain-pro
+
+Users can install with:
+```bash
+npm install -g specchain-pro
+```
+
+---
+
+## 📞 Need Help?
+
+- Check: `NPM_PUBLISH_STEPS.md` for detailed steps
+- Check: `DEPLOYMENT_GUIDE.md` for full guide
+- Check: `PUBLISH_COMMANDS.txt` for quick commands
+
+---
+
+**Ready to deploy? Let's go! 🚀**
+
+Start with: `.\setup-git.ps1` (Windows) or `./setup-git.sh` (Linux/Mac)

package/dist/cli/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":""}

package/dist/cli/index.js

@@ -0,0 +1,182 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const config_1 = require("../core/config");
+const logger_1 = __importDefault(require("../utils/logger"));
+const program = new commander_1.Command();
+// CLI metadata
+program
+    .name('spec')
+    .description('SpecChain Pro - AI-powered specification generation with blockchain proof-of-authorship')
+    .version('0.1.0');
+// Global options
+program
+    .option('-v, --verbose', 'Enable verbose logging')
+    .option('-c, --config <path>', 'Path to custom config file');
+// Command: spec new
+program
+    .command('new [idea]')
+    .description('Generate a new specification from an idea summary')
+    .option('-o, --output <path>', 'Output file path')
+    .action(async (idea, _options) => {
+    try {
+        console.log(chalk_1.default.blue('🚀 Generating specification...'));
+        if (!idea) {
+            console.log(chalk_1.default.yellow('Please provide an idea summary:'));
+            console.log(chalk_1.default.gray('Example: spec new "Build a real-time chat app with WebRTC"'));
+            return;
+        }
+        // TODO: Implement AI spec generation
+        console.log(chalk_1.default.green('✓ Specification generated successfully!'));
+        console.log(chalk_1.default.gray('Note: AI generation not yet implemented'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('✗ Failed to generate specification'));
+        if (program.opts().verbose) {
+            console.error(error);
+        }
+        process.exit(1);
+    }
+});
+// Command: spec sign
+program
+    .command('sign <spec-id>')
+    .description('Create a blockchain proof-of-authorship for a specification')
+    .action(async (_specId) => {
+    try {
+        console.log(chalk_1.default.blue('🔐 Creating blockchain proof...'));
+        // TODO: Implement blockchain signing
+        console.log(chalk_1.default.green('✓ Blockchain proof created successfully!'));
+        console.log(chalk_1.default.gray('Note: Blockchain integration not yet implemented'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('✗ Failed to create blockchain proof'));
+        if (program.opts().verbose) {
+            console.error(error);
+        }
+        process.exit(1);
+    }
+});
+// Command: spec verify
+program
+    .command('verify <spec-id>')
+    .description('Verify a specification against its blockchain proof')
+    .action(async (_specId) => {
+    try {
+        console.log(chalk_1.default.blue('🔍 Verifying specification...'));
+        // TODO: Implement verification
+        console.log(chalk_1.default.green('✓ Specification verified successfully!'));
+        console.log(chalk_1.default.gray('Note: Verification not yet implemented'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('✗ Verification failed'));
+        if (program.opts().verbose) {
+            console.error(error);
+        }
+        process.exit(1);
+    }
+});
+// Command: spec list
+program
+    .command('list')
+    .description('List all local specifications')
+    .option('-t, --tags <tags>', 'Filter by tags (comma-separated)')
+    .option('-a, --author <author>', 'Filter by author')
+    .action(async (_options) => {
+    try {
+        console.log(chalk_1.default.blue('📋 Listing specifications...'));
+        // TODO: Implement list functionality
+        console.log(chalk_1.default.gray('No specifications found'));
+        console.log(chalk_1.default.gray('Note: Storage layer not yet implemented'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('✗ Failed to list specifications'));
+        if (program.opts().verbose) {
+            console.error(error);
+        }
+        process.exit(1);
+    }
+});
+// Command: spec export
+program
+    .command('export <spec-id> <format>')
+    .description('Export a specification to different formats (markdown, json, github)')
+    .option('-o, --output <path>', 'Output file path')
+    .action(async (specId, format, _options) => {
+    try {
+        console.log(chalk_1.default.blue(`📤 Exporting specification to ${format}...`));
+        // TODO: Implement export functionality
+        console.log(chalk_1.default.green('✓ Specification exported successfully!'));
+        console.log(chalk_1.default.gray('Note: Export system not yet implemented'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('✗ Export failed'));
+        if (program.opts().verbose) {
+            console.error(error);
+        }
+        process.exit(1);
+    }
+});
+// Command: spec config
+program
+    .command('config [action]')
+    .description('View or update configuration (actions: show, set)')
+    .option('-k, --key <key>', 'Configuration key to set')
+    .option('-v, --value <value>', 'Configuration value')
+    .action(async (action, options) => {
+    try {
+        if (!action || action === 'show') {
+            console.log(chalk_1.default.blue('⚙️  Current configuration:'));
+            const config = await config_1.configManager.load();
+            console.log(JSON.stringify(config, null, 2));
+        }
+        else if (action === 'set') {
+            if (!options.key || !options.value) {
+                console.log(chalk_1.default.yellow('Please provide both --key and --value'));
+                return;
+            }
+            console.log(chalk_1.default.blue('⚙️  Updating configuration...'));
+            // TODO: Implement config update
+            console.log(chalk_1.default.green('✓ Configuration updated successfully!'));
+        }
+        else {
+            console.log(chalk_1.default.yellow(`Unknown action: ${action}`));
+            console.log(chalk_1.default.gray('Available actions: show, set'));
+        }
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('✗ Configuration operation failed'));
+        if (program.opts().verbose) {
+            console.error(error);
+        }
+        process.exit(1);
+    }
+});
+// Initialize and parse
+async function main() {
+    try {
+        // Set log level based on verbose flag
+        if (program.opts().verbose) {
+            process.env.LOG_LEVEL = 'debug';
+        }
+        // Initialize configuration
+        await config_1.configManager.load();
+        // Parse command line arguments
+        await program.parseAsync(process.argv);
+    }
+    catch (error) {
+        logger_1.default.error('CLI initialization failed', { error });
+        console.error(chalk_1.default.red('✗ Failed to initialize SpecChain Pro'));
+        if (program.opts().verbose) {
+            console.error(error);
+        }
+        process.exit(1);
+    }
+}
+main();
+//# sourceMappingURL=index.js.map