heyio 3.3.5 → 4.0.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,83 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <https://github.com/michaeljolley/io/issues>. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michael Jolley
+
+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

@@ -1,217 +1,269 @@
 <p align="center">
-  <img src="assets/IO-logo.svg" alt="IO Logo" width="200" />
+  <img src="assets/IO-logo.svg" alt="IO" width="200" />
 </p>
 
 <h1 align="center">IO</h1>
 
 <p align="center">
-  <strong>AI Orchestrator Daemon — manage specialized agent squads for your software projects</strong>
+  A self-hosted AI orchestrator daemon with squad-based team delegation.
 </p>
 
 <p align="center">
-  <a href="https://michaeljolley.github.io/io">Documentation</a> •
-  <a href="#getting-started">Getting Started</a> •
-  <a href="#architecture">Architecture</a>
+  <a href="https://www.npmjs.com/package/heyio"><img src="https://img.shields.io/npm/v/heyio" alt="npm version" /></a>
+  <a href="https://github.com/michaeljolley/io/actions"><img src="https://github.com/michaeljolley/io/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+  <img src="https://img.shields.io/node/v/heyio" alt="node version" />
+  <a href="LICENSE"><img src="https://img.shields.io/github/license/michaeljolley/io" alt="license" /></a>
 </p>
 
 ---
 
 ## What is IO?
 
-IO is an always-running daemon that acts as your personal AI orchestrator. You talk to IO, and IO manages teams of specialized AI agents ("squads") that work on your codebases.
-
-- **One conversation interface** — talk to IO via TUI, Telegram, or the web dashboard
-- **Squad delegation** — IO automatically routes project questions to the right squad
-- **Universe theming** — squads get pop-culture character names and personas via LLM
-- **Web dashboard** — React SPA with real-time chat, squad management, and usage charts
-- **Cron schedules** — automate recurring tasks like daily standups or issue triage
-- **Inbox system** — squads can send you deliverables or ask blocking questions
-- **Model management** — token tracking and configurable model selection per agent
-
-## Architecture
-
-```mermaid
-graph TD
-    User["🧑 You<br/>(TUI / Telegram / Web)"]
-    Orch["🤖 Orchestrator<br/>(Copilot SDK · tool-calling)"]
-    Wiki["📚 Wiki<br/>(Knowledge Base)"]
-    Skills["🧩 Skills<br/>(SKILL.md)"]
-    Sched["⏰ Scheduler<br/>(cron jobs)"]
-    SquadA["👥 Squad A<br/>(Team Lead + Agents)"]
-    SquadB["👥 Squad B<br/>(Team Lead + Agents)"]
-    Web["🌐 Web Dashboard<br/>(React SPA)"]
-
-    User --> Orch
-    User --> Web
-    Web --> Orch
-    Orch --> SquadA
-    Orch --> SquadB
-    Orch --> Sched
-    Orch --> Wiki
-    Orch --> Skills
-    SquadA --> Wiki
-    SquadB --> Wiki
-```
-
-Each squad has:
-- **Team Lead** — receives objectives, creates plans, coordinates agents
-- **Agents** — specialized workers (developer, reviewer, etc.) with pop-culture character names
-- **Meetings** — structured collaboration between agents for planning and review
-- **QA/Tester** — required veto-holding member who must approve before completion
-
-## Getting Started
+IO is your personal AI companion — an always-on daemon you communicate with via a **web dashboard** or **Telegram**. It can answer questions directly, manage a personal wiki, schedule recurring tasks, and delegate project-specific work to **squads** of specialized AI agents.
 
-### Prerequisites
+### Key Concepts
+
+- **Io** — The orchestrator. It routes your messages, manages squads, and can do direct coding work on repos without a squad.
+- **Squad** — A team of AI agents assigned to a single repository. Each squad has a Team Lead, a QA agent, and LLM-generated specialist roles.
+- **Execution Pipeline** — When a squad receives an objective: plan → parallel agents (git worktrees) → review → QA veto → PR creation.
 
-- Node.js 22+
-- GitHub Copilot access (the daemon uses `@github/copilot-sdk`)
-- Git
+---
 
-### Installation
+## Features
+
+- 🤖 **Smart Model Routing** — Io classifies messages by complexity and routes to fast/standard/premium models automatically
+- 👥 **Squad Delegation** — Hire a squad for any repo; Io delegates all project questions to it
+- 🔄 **Parallel Execution** — Agents work simultaneously in isolated git worktrees
+- ✅ **QA Gate** — Mandatory QA review with veto power (max 3 revision cycles before escalation)
+- 📋 **4 PR Modes** — Branch-only, draft PR, ready PR, or auto-merge (configurable per squad)
+- 📅 **Cron Scheduler** — Automate recurring tasks (daily standups, issue triage, dependency updates)
+- 📬 **Inbox** — Blocking questions and deliverables from squads, reviewed at your pace
+- 📝 **Wiki** — Personal knowledge base with search, tags, and episodic memory
+- 🔌 **Skills** — Extensible via SKILL.md files (install from GitHub or marketplace)
+- 🔧 **MCP Support** — Agents can connect to external MCP servers
+- 📊 **Token Tracking** — Per-agent usage granularity with cost breakdowns
+- 💬 **Telegram** — Chat with Io and receive notifications on your phone
+- 🌐 **Web Dashboard** — Full-featured React app (chat, squads, inbox, wiki, schedules, usage, skills)
+
+---
+
+## Quick Start
+
+### Install
 
 ```bash
-git clone https://github.com/michaeljolley/io.git
-cd io
-npm install
-npm run build
+npm install -g heyio
 ```
 
-### Running
+### Setup
 
 ```bash
-# Start the daemon
-npm run dev
+io setup
+```
+
+This creates `~/.io/config.json` with your preferences (port, Telegram token, Supabase auth, etc.)
+
+### Run
 
-# Or build and start
-npm run build
-npm start
+```bash
+io
 ```
 
-The daemon starts on port `7777` by default. The web dashboard is served at the same port — open `http://localhost:7777` in your browser.
+The daemon starts and serves the web dashboard at `http://localhost:7777`.
+
+---
 
-### Configuration
+## Requirements
 
-Create `~/.io/config.json`:
+- **Node.js 22+**
+- **GitHub Copilot** subscription (for the `@github/copilot-sdk`)
+- **Git** and **gh** CLI (for squad PR creation)
+- **Telegram Bot Token** (optional, for mobile access)
+
+---
+
+## Configuration
+
+IO stores all data in `~/.io/`:
 
-```json
-{
-  "apiPort": 7777,
-  "defaultModel": "claude-opus-4.6",
-  "logLevel": "info",
-  "maxInstancesPerSquad": 3,
-  "telegram": {
-    "botToken": "your-token-from-botfather",
-    "allowedChatIds": [12345678]
-  },
-  "supabase": {
-    "projectUrl": "https://your-project.supabase.co",
-    "anonKey": "eyJ...",
-    "jwtSecret": "your-jwt-secret"
-  }
-}
 ```
+~/.io/
+├── config.json       # Main configuration
+├── io.db             # SQLite database
+├── wiki/pages/       # Wiki markdown pages
+├── skills/           # Installed SKILL.md files
+├── skills-lock.json  # Skills manifest
+└── logs/io.log       # Structured logs
+```
+
+### Config Options
 
-All settings can also be controlled via environment variables (which take priority):
+| Key | Env Variable | Default | Description |
+|-----|-------------|---------|-------------|
+| `port` | `IO_PORT` | `7777` | API server port |
+| `logLevel` | `IO_LOG_LEVEL` | `info` | Log level (trace/debug/info/warn/error) |
+| `defaultModel` | `IO_DEFAULT_MODEL` | `gpt-4.1` | Default LLM model |
+| `telegramToken` | `IO_TELEGRAM_TOKEN` | — | Telegram bot token |
+| `telegramUserId` | `IO_TELEGRAM_USER_ID` | — | Your Telegram user ID |
+| `supabaseUrl` | `IO_SUPABASE_URL` | — | Supabase URL (for dashboard auth) |
+| `supabaseAnonKey` | `IO_SUPABASE_ANON_KEY` | — | Supabase anon key |
+| `sessionResetThreshold` | `IO_SESSION_RESET_THRESHOLD` | `50` | Messages before session reset |
 
-| Variable | Config Key | Default |
-|----------|-----------|---------|
-| `IO_PORT` | `apiPort` | `7777` |
-| `IO_LOG_LEVEL` | `logLevel` | `info` |
-| `IO_MODEL` | `defaultModel` | `claude-opus-4.6` |
-| `IO_DATA_DIR` | `dataDir` | `~/.io` |
-| `TELEGRAM_BOT_TOKEN` | `telegram.botToken` | — |
-| `TELEGRAM_ALLOWED_CHAT_IDS` | `telegram.allowedChatIds` | — |
-| `IO_SUPABASE_URL` | `supabase.projectUrl` | — |
-| `IO_SUPABASE_ANON_KEY` | `supabase.anonKey` | — |
-| `IO_SUPABASE_JWT_SECRET` | `supabase.jwtSecret` | — |
+---
 
-See the [Configuration Guide](https://michaeljolley.github.io/io/guides/configuration/) for full details.
+## Squads
 
-### Authentication
+### Hiring a Squad
 
-When Supabase is configured, the web dashboard requires login and all API endpoints are secured with JWT verification. If Supabase is **not** configured, the API stays open (suitable for local-only use).
+Tell Io to hire a squad for a repository:
 
-## Key Features
+> "Hire a squad for https://github.com/myorg/my-app"
 
-### Squads
+Io analyzes the repo, proposes a team composition (Team Lead + QA + specialists), and asks for your approval.
 
-Hire a squad for any project:
+### Squad Composition
 
-> "Hire a squad for https://github.com/org/my-app with the Star Wars universe"
+| Role | Mandatory | Purpose |
+|------|-----------|---------|
+| Team Lead | ✅ | Plans objectives, assigns tasks, picks models |
+| QA | ✅ | Reviews diffs, runs tests, approves/rejects |
+| *Generated* | ❌ | Specialists based on repo (e.g., "API Developer", "UI Specialist") |
 
-IO creates a team with character names from your chosen universe (e.g., "Yoda" as Team Lead, "R2-D2" as DevOps). Each member gets a persona that influences their communication style.
+### PR Modes
 
-### Web Dashboard
+Configure per squad how completed work is delivered:
 
-A full React SPA served by the daemon at the API port:
-- **Chat** — real-time streaming conversation with IO
-- **Squads** — view teams, members, active instances, and activity
-- **Feed** — inbox of deliverables and blocking questions
-- **Skills** — manage installed SKILL.md capabilities
-- **Schedules** — CRUD for cron-based automation
-- **Wiki** — knowledge base viewer and editor
-- **Usage** — token and cost charts (by squad, model, time)
-- **Settings** — configure all daemon options from the UI
+| Mode | Behavior |
+|------|----------|
+| `branch-only` | Branch pushed; PR only if QA approves |
+| `draft-pr` | Draft PR created; promoted to ready on QA approval |
+| `ready-pr` | PR created as ready; stays open if QA rejects |
+| `auto-merge` | PR created; auto-merged on QA approval |
 
-### Schedules
+---
 
-Automate recurring work with cron expressions:
+## Execution Pipeline
 
-> "Create a daily standup for my-app at 9am on weekdays — have them review open issues and report progress"
+```
+Objective received
+  → Team Lead creates plan
+    → Tasks assigned to agents
+      → Agents execute in parallel (git worktrees)
+        → Review meeting
+          → QA gate
+            ├─ Approved → Push branch + create PR (per prMode)
+            ├─ Rejected (< 3x) → Agents revise with feedback
+            └─ Rejected (3x) → Escalate to inbox
+```
 
-### Inbox
+---
 
-Squads communicate back via the inbox:
-- **Deliverables** — status reports, completed summaries
-- **Blocking questions** — the squad pauses and waits for your answer
+## Development
 
-### Clients
+### Prerequisites
 
-| Client | Description |
-|--------|-------------|
-| Web Dashboard | React SPA at `http://localhost:7777` |
-| TUI | Terminal interface built with Ink |
-| Telegram | Bot integration via Grammy |
-| REST API | HTTP endpoints at `/api/*` |
-| WebSocket | Real-time streaming at `/ws` |
+```bash
+node --version  # >= 22.0.0
+git --version
+gh --version
+```
 
-## Project Structure
+### Setup
 
+```bash
+git clone https://github.com/michaeljolley/io.git
+cd io
+npm install
 ```
-packages/
-├── shared/      # Types, constants, shared utilities
-├── daemon/      # Core daemon (orchestrator, squads, API, scheduler)
-├── web/         # Web dashboard (React + Vite + Tailwind)
-├── tui/         # Terminal UI (Ink/React)
-└── telegram/    # Telegram bot client
-docs/            # Astro Starlight documentation site
-.github/
-└── workflows/
-    ├── ci.yml           # PR validation (lint, build, test)
-    ├── release.yml      # Tag-based release + npm publish
-    └── deploy-docs.yml  # Docs site deployment
+
+### Build
+
+```bash
+npm run build          # Build all packages
+npm run build:shared   # Build shared types
+npm run build:daemon   # Build daemon with esbuild
+npm run build:web      # Build web dashboard with Vite
 ```
 
-## Development
+### Dev Mode
 
 ```bash
-# Build all packages
-npm run build
+npm run dev            # Run daemon with tsx --watch
+```
+
+### Test
 
-# Run daemon in dev mode (watches for changes)
-npm run dev
+```bash
+npm test               # Run all tests
+npm run test:watch     # Watch mode
+npm run test:coverage  # With coverage
+```
 
-# Run web dashboard dev server (with API proxy)
-cd packages/web && npm run dev
+### Lint
 
-# Build documentation
-cd docs && npm run build
+```bash
+npm run lint           # Check with Biome
+npm run lint:fix       # Auto-fix
+npm run format         # Format with Biome
 ```
 
-## Documentation
+---
+
+## Project Structure
 
-Full documentation is available at **[michaeljolley.github.io/io](https://michaeljolley.github.io/io)**.
+```
+packages/
+├── shared/           # Types, constants, config schema
+├── daemon/           # Core daemon (orchestrator, squads, execution, API)
+│   └── src/
+│       ├── orchestrator/   # Io brain + tools
+│       ├── squad/          # Squad hiring + management
+│       ├── execution/      # Full pipeline (plan, tasks, agents, QA, PR)
+│       ├── copilot/        # Copilot SDK integration + model routing
+│       ├── store/          # libSQL database layer
+│       ├── api/            # Express REST + WebSocket
+│       ├── wiki/           # Personal knowledge base
+│       ├── skills/         # SKILL.md extensibility
+│       ├── scheduler/      # Cron automation
+│       └── telegram/       # Grammy bot + notifications
+└── web/              # React dashboard (Vite + Tailwind + Radix UI)
+```
+
+---
+
+## API
+
+The daemon exposes a REST API + WebSocket at the configured port (default 7777).
+
+### Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| POST | `/api/chat` | Send message to Io |
+| GET | `/api/conversations` | List conversations |
+| GET | `/api/squads` | List squads |
+| POST | `/api/squads` | Create squad |
+| POST | `/api/squads/:id/objectives` | Assign objective |
+| GET | `/api/inbox` | List inbox items |
+| POST | `/api/inbox/:id/reply` | Reply to inbox item |
+| GET | `/api/schedules` | List schedules |
+| POST | `/api/schedules` | Create schedule |
+| GET | `/api/wiki/pages` | List wiki pages |
+| GET | `/api/wiki/search` | Search wiki |
+| GET | `/api/skills` | List installed skills |
+| GET | `/api/usage` | Token usage summary |
+| GET | `/api/activity` | Activity feed |
+
+### WebSocket
+
+Connect to `ws://localhost:7777` and subscribe to channels for real-time events:
+
+```json
+{ "type": "subscribe", "channels": ["chat", "inbox", "activity"] }
+```
+
+---
 
 ## License
 
-MIT
+[MIT](LICENSE)