{"_id":"@asxuu/vela","name":"@asxuu/vela","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@asxuu/vela","version":"1.0.0","description":"Read an entire codebase line by line with async iterators - renamed to vela","main":"dist/index.js","types":"dist/index.d.ts","bin":{"vela":"dist/cli.js"},"scripts":{"build":"tsc","dev":"ts-node src/index.ts"},"keywords":["codebase","reader","ast","files","cli"],"license":"MIT","devDependencies":{"@types/diff":"^7.0.2","@types/node":"^25.9.3","ts-node":"^10.9.2","typescript":"^6.0.3"},"dependencies":{"chokidar":"^3.6.0","diff":"^5.0.0"},"gitHead":"c9d9915aa5badf8dd8d060d2a735fa4694e372f1","_id":"@asxuu/vela@1.0.0","_nodeVersion":"22.16.0","_npmVersion":"11.12.1","dist":{"integrity":"sha512-yrPZOLjMpu+LIxAs4+Y0wrysEiXM8jdpUcGiaxpye8C+NB5o4VxGLd2v+Xg0nN+EHMt+OAiqC/twcgBh3CVgnA==","shasum":"ac2b42d532437fc345ecc3f059bdc17f7e2cdde7","tarball":"https://registry.npmjs.org/@asxuu/vela/-/vela-1.0.0.tgz","fileCount":48,"unpackedSize":162101,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICoUUMrrakW3fc5iDWF0GDl2I7qVxjWA2++JY88P9+KEAiAJFtcIaFoexuv97RZxAiZ9ulpQBDbAfu4E6zQjGb3QkA=="}]},"_npmUser":{"name":"asxuu","email":"asadhussain2408@gmail.com"},"directories":{},"maintainers":[{"name":"asxuu","email":"asadhussain2408@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/vela_1.0.0_1781596499084_0.15188422157432013"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-16T07:54:58.880Z","1.0.0":"2026-06-16T07:54:59.248Z","modified":"2026-06-16T07:54:59.488Z"},"maintainers":[{"name":"asxuu","email":"asadhussain2408@gmail.com"}],"description":"Read an entire codebase line by line with async iterators - renamed to vela","keywords":["codebase","reader","ast","files","cli"],"license":"MIT","readme":"# Vela ⛵\n\n[](https://www.npmjs.com/package/vela)\n[](https://github.com/your-username/vela/blob/main/LICENSE)\n[](https://www.npmjs.com/package/vela)\n\n**Vela** is a lightweight, AI-friendly micro-version control system (VCS) companion. It is designed to work alongside Git to track codebase changes in real-time, generate targeted context rules for AI editors/agents, and orchestrate quick rollbacks during rapid feature development cycles.\n\n---\n\n## Key Capabilities\n\n* **Targeted Context Injection**: Customize rules dynamically for **Claude Code, Cursor, Copilot, Windsurf, Antigravity, and Codex**.\n* **Zero Bloat Diff Storage**: Saves only line-level diff hunks in `.vela/changes/` rather than copying entire files.\n* **Automatic Clean Cycle**: Automatically purges active checkpoints and deletes changes files upon running `git commit` via post-commit hooks.\n* **Granular Diff Inspection**: Compare workspace files line-by-line against local checkpoints before applying a restore.\n\n---\n\n## Architecture Flow\n\n```mermaid\nsequenceDiagram\n participant Developer\n participant Vela as Vela CLI\n participant Agent as AI Agent (e.g. Claude Code)\n participant Git\n \n Developer->>Vela: vela claude (or vela cursor, etc.)\n Note over Vela: Initializes .vela/store.json
Writes targeted rules file\n Developer->>Vela: vela hook\n Note over Vela: Installs git post-commit hook\n Agent->>Vela: vela snap --intent=\"add dark mode\"\n Note over Vela: Saves line-level diffs to .vela/changes/\n Developer->>Vela: vela diff dark-mode\n Note over Vela: Compares checkpoint with workspace disk\n Developer->>Vela: vela restore dark-mode\n Note over Vela: Restores file lines to previous state\n Developer->>Git: git commit -m \"add dark mode\"\n Git->>Vela: vela commit-purge (via git hook)\n Note over Vela: Deletes .vela/changes/*
Keeps store.json slim\n```\n\n---\n\n## Installation\n\nInstall globally via npm:\n```bash\nnpm install -g vela\n```\n\n---\n\n## Getting Started\n\n### 1. Initialize Targeted Rules\nRun the command corresponding to the AI editor or agent you are using. This configures the local store and injects rules explaining how your AI assistant can read checkpoints and trigger rollbacks:\n\n```bash\n# For Claude Code\nvela claude\n\n# For Cursor IDE\nvela cursor\n\n# For GitHub Copilot\nvela copilot\n\n# For Windsurf Editor\nvela windsurf\n\n# For Antigravity CLI\nvela agy\n\n# For generic Codex models\nvela codex\n\n# For all platforms\nvela init\n```\n\n*Enable auto-purge by installing the Git post-commit hook:*\n```bash\nvela hook\n```\n\n---\n\n## Command Reference & Typical Workflow\n\n### 1. Snapshot State\nWhen you (or your AI agent) start working on a feature, capture the working state:\n```bash\nvela snap --intent=\"implement auth\"\n```\n* Generates a semantic codename: `amber-implement-auth-066c20`.\n* Saves specific diff hunks under `.vela/changes/amber-implement-auth-066c20.json`.\n\n### 2. Inspect Checkpoint Differences\nCompare files on disk with the code stored in a checkpoint. You can use full codenames or convenient Git-like aliases (`last`, `prev`, `last~1`, `~2`, etc.):\n```bash\n# Diff using codename\nvela diff implement-auth\n\n# Diff using aliases (last checkpoint, 2nd-to-last checkpoint)\nvela diff last\nvela diff prev\n\n# Diff a specific file\nvela diff last package.json\n```\n\n### 3. Inspect File Contents\nInspect the line-by-line contents of a file inside the checkpoint database:\n```bash\nvela show last src/index.ts\n```\n\n### 4. Roll Back State\nRevert workspace files back to a previous checkpoint:\n```bash\n# Revert to the last snap, or the one before it\nvela restore last\nvela restore last~1\n```\n\n### 5. Git Commit Integration\nOnce your changes are committed to Git, Vela automatically purges local history files to keep the directory completely clean:\n```bash\ngit commit -am \"feat: implement auth\"\n# Git hook automatically fires 'vela commit-purge'\n```\n\n---\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","readmeFilename":"README.md","_rev":"1-d108a59799a2fdf697bbb51849aafe94"}