SpecChain Pro

AI-powered specification generation with blockchain proof-of-authorship

🚀 Quick Start

# 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)

npm install -g github:yourusername/specchain-pro

Option 2: Install from Source

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)

npm install -g specchain-pro

Note: npm publishing is optional. See DEPLOY_WITHOUT_NPM.md for alternative deployment methods.

📖 Usage

Generate a new specification

spec new "Build a real-time chat application with WebRTC"

Sign a specification (create blockchain proof)

spec sign spec-123

Verify a specification

spec verify spec-123

List all specifications

spec list
spec list --tags "web,api"
spec list --author "0xYourAddress"

Export a specification

spec export spec-123 markdown
spec export spec-123 json --output ./my-spec.json
spec export spec-123 github

Manage configuration

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:

{
  "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:

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

# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run with coverage
npm test -- --coverage

Linting and Formatting

# Lint code
npm run lint

# Format code
npm run format

📚 Documentation

• Problem Statement
• Solution Proposal
• Product Roadmap
• Requirements
• Design Document
• Implementation Tasks

🗺️ 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 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 file for details.

🙏 Acknowledgments

• OpenAI for GPT-4 API
• Ethereum and Layer 2 communities
• All contributors and supporters

📞 Support

• Documentation: docs/
• Issues: GitHub Issues
• Discussions: GitHub Discussions

Status: 🚧 MVP Development in Progress

Version: 0.1.0 (Alpha)

Last Updated: January 2025 "# specchain-pro"