OnlySpecs  by lidangzzz

Electron app for spec-driven development and AI code analysis

Created 1 month ago
265 stars

Top 96.3% on SourcePulse

GitHubView on GitHub
Project Summary

OnlySpecs is an Electron-based desktop application designed to streamline software development by managing specifications and their corresponding code implementations in a version-controlled, organized manner. It targets developers seeking a unified environment to write specs, analyze codebases, and implement features, enhanced by AI assistance, thereby improving project clarity and traceability.

How It Works

The application leverages Electron for its desktop framework, integrating a feature-rich Monaco Editor for a VS Code-like coding experience and node-pty with xterm.js for robust, multi-terminal support. A core design principle is the explicit organization of specifications (e.g., specs_v0001.md) and their matching code implementations (e.g., code_v0001/), facilitating a specification-driven development workflow. AI capabilities are powered by the Claude Agent SDK, enabling automated code analysis and specification generation directly from existing codebases.

Quick Start & Requirements

  • Prerequisites: Node.js 18+ (LTS recommended), npm or yarn, Git (for GitHub import), Claude CLI (optional for AI features).
  • Installation: Clone the repository, run npm install, and then npm run postinstall to rebuild native modules for node-pty.
  • Development: Launch the development server with npm run dev or npm start.
  • Packaging: Use npm run package to package the application, npm run make for installers, and npm run publish for distribution.
  • Configuration: API keys and preferences are managed via a Settings modal or directly in ~/Documents/OnlySpecs/config.json.
  • Links: The primary link is the GitHub repository: https://github.com/lidangzzz/OnlySpecs. No separate official quick-start, docs, or demo links are provided in the README.

Highlighted Details

  • AI-Powered Code Analysis: Integrates the Claude Agent SDK for automated codebase analysis, generating architectural specifications from code, and cloning/analyzing GitHub repositories.
  • Version-Controlled Workflow: Enforces a clear separation and versioning of specifications (specs_vXXX.md) and code implementations (code_vXXX/), supporting iterative development.
  • Integrated Development Environment: Features a multi-tab Monaco Editor, simultaneous terminal sessions with full PTY emulation, a file explorer, and customizable UI layout with resizable panels.

Maintenance & Community

The provided README does not detail specific contributors, sponsorships, partnerships, or community channels (e.g., Discord, Slack). The primary point of contact and community interaction would likely be through the GitHub repository.

Licensing & Compatibility

The project is released under the MIT License, which generally permits commercial use and integration with closed-source projects without significant restrictions.

Limitations & Caveats

The setup requires development build tools for node-pty compilation, which can sometimes be a point of failure. Full AI functionality is dependent on the installation and configuration of the Claude CLI and valid API keys. The README does not explicitly mention automated testing coverage or specific performance benchmarks.

Health Check
Last Commit

1 month ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
1
Star History
42 stars in the last 30 days

Explore Similar Projects

Starred by Alex Yu Alex Yu(Research Scientist at OpenAI; Cofounder of Luma AI), Will Brown Will Brown(Research Lead at Prime Intellect), and
7 more.

avante.nvim by yetone

0.3%
18k
Neovim plugin emulating Cursor AI IDE for AI-driven code assistance
Created 1 year ago
Updated 1 week ago
Feedback? Help us improve.