@vladimir-ks/aigile 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vladimir K.S.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,117 @@
+# AIGILE
+
+> JIRA-compatible Agile project management CLI for AI-assisted development
+
+AIGILE is a command-line tool that brings agile project management directly to your repository. Designed for AI-assisted development workflows, it tracks epics, stories, tasks, and bugs with a file-first architecture.
+
+## Features
+
+- **File-First Architecture**: Documents with YAML frontmatter are the source of truth
+- **Automatic Sync**: File watcher daemon keeps database in sync with your files
+- **JIRA-Compatible**: Familiar concepts (Epics, Stories, Tasks, Bugs, Sprints)
+- **AI-Optimized**: Designed for Claude Code and other AI assistants
+- **Three Init Profiles**: `full-repo`, `subrepo`, `module` for different project structures
+- **Frontmatter Metadata**: Status, version, modules, dependencies tracking
+
+## Installation
+
+```bash
+npm install -g @vladimir-ks/aigile
+```
+
+## Quick Start
+
+```bash
+# Initialize in your git repository
+aigile init
+
+# Scan and index your files
+aigile sync scan
+
+# Start the file watcher daemon
+aigile daemon install
+aigile daemon start
+
+# View project status
+aigile status
+```
+
+## Commands
+
+### Project Management
+- `aigile init` - Initialize AIGILE in a repository
+- `aigile project list` - List registered projects
+- `aigile status` - Show project status
+
+### Work Items
+- `aigile epic create "Epic title"` - Create an epic
+- `aigile story create "Story title"` - Create a user story
+- `aigile task create "Task title"` - Create a task
+- `aigile bug create "Bug title"` - Create a bug report
+
+### File Sync
+- `aigile sync scan` - Scan and sync files to database
+- `aigile sync status` - Show sync status
+- `aigile sync list` - List tracked documents
+
+### Document Management
+- `aigile doc list` - List documents with metadata
+- `aigile doc show <path>` - Show document details
+- `aigile doc update <path>` - Update frontmatter metadata
+- `aigile doc stats` - Show frontmatter statistics
+
+### Daemon
+- `aigile daemon install` - Install auto-start service
+- `aigile daemon start` - Start file watcher
+- `aigile daemon stop` - Stop file watcher
+- `aigile daemon status` - Show daemon status
+
+## Init Profiles
+
+### full-repo
+For primary product repositories at the git root:
+```bash
+aigile init --profile full-repo
+```
+
+### subrepo
+For git submodules treated as separate products:
+```bash
+aigile init --profile subrepo
+```
+
+### module
+For directories within an existing AIGILE repository:
+```bash
+aigile init --profile module --name my-module
+```
+
+## Frontmatter Schema
+
+AIGILE tracks documents with YAML frontmatter:
+
+```yaml
+---
+metadata:
+  status: DRAFT          # DRAFT, IN-REVIEW, APPROVED, TEMPLATE
+  version: "1.0"
+  tldr: "Brief summary"
+  modules: [auth, api]
+  dependencies: [./other-doc.md]
+  code_refs: [src/auth/]
+  authors: ["Author Name"]
+---
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+- Git repository
+
+## License
+
+MIT
+
+## Author
+
+Vladimir K.S. - [@vladimir-ks](https://github.com/vladimir-ks)