@flydocs/cli 0.5.0-beta.0

package/README.md

@@ -0,0 +1,96 @@
+# FlyDocs Core
+
+AI-assisted spec-driven development for your codebase. FlyDocs installs skills, workflows, and issue management directly into your project — works with Claude Code and Cursor.
+
+## Install
+
+```bash
+npm install -g @flydocs/cli
+```
+
+Beta releases:
+
+```bash
+npm install -g @flydocs/cli@beta
+```
+
+Requires Node.js >= 18.17.0 and Python 3.8+ (for mechanism scripts).
+
+## Quick Start
+
+```bash
+# Install FlyDocs into your project
+cd your-project
+flydocs
+
+# Open your IDE and run the guided setup
+/flydocs-setup
+
+# Start working
+/start-session
+```
+
+### Tiers
+
+| Tier                  | Install                | Backend                                |
+| --------------------- | ---------------------- | -------------------------------------- |
+| **Local** (free)      | `flydocs --tier local` | File-based issues in `flydocs/issues/` |
+| **Cloud** (connected) | `flydocs --tier cloud` | Linear via GraphQL API                 |
+
+Local tier requires no accounts or API keys. Cloud tier needs a `LINEAR_API_KEY` in `.env`.
+
+## What Gets Installed
+
+FlyDocs adds workflow infrastructure alongside your code:
+
+| Component     | Location             | Purpose                                                      |
+| ------------- | -------------------- | ------------------------------------------------------------ |
+| **Skills**    | `.claude/skills/`    | Workflow, issue management, context graph                    |
+| **Commands**  | `.claude/commands/`  | Slash commands (`/capture`, `/activate`, `/implement`, etc.) |
+| **Agents**    | `.claude/agents/`    | Subagent definitions (PM, Implementation, QE, Research)      |
+| **Context**   | `flydocs/context/`   | Project definition and priorities                            |
+| **Knowledge** | `flydocs/knowledge/` | Decisions, notes, product docs                               |
+| **Config**    | `.flydocs/`          | Templates, hooks, version tracking                           |
+
+## Commands
+
+### CLI
+
+| Command          | Purpose                            |
+| ---------------- | ---------------------------------- |
+| `flydocs`        | Fresh install into current project |
+| `flydocs update` | Update to latest version           |
+| `flydocs --help` | Show all options                   |
+
+### IDE (Claude Code / Cursor)
+
+| Command          | Purpose                     |
+| ---------------- | --------------------------- |
+| `/flydocs-setup` | Guided project onboarding   |
+| `/start-session` | Begin a work session        |
+| `/capture`       | Create a new issue          |
+| `/activate`      | Pick up an issue to work on |
+| `/implement`     | Start implementation        |
+| `/review`        | Submit for code review      |
+| `/wrap-session`  | End session with summary    |
+
+## Updating
+
+```bash
+# Update FlyDocs in your project
+flydocs update
+
+# Force reinstall at same version
+flydocs update --force
+```
+
+Updates replace framework files while preserving your project content, config, and issues.
+
+## Links
+
+- **Website**: [flydocs.ai](https://www.flydocs.ai)
+- **Source**: [github.com/plastrlab/flydocs-core](https://github.com/plastrlab/flydocs-core)
+
+## License
+
+Proprietary - All rights reserved.