@deimoscloud/coreai 0.1.0 → 0.1.2

package/README.md

@@ -19,17 +19,26 @@ npm install -g @deimoscloud/coreai
 ## Quick Start
 
 ```bash
-# Initialize a new project (coming soon)
+# Initialize a new project
 coreai init
 
 # Build agents to .claude/agents/
 coreai build
 
+# Build agents and initialize KnowledgeLibrary
+coreai build --init-knowledge-library
+
+# Generate Claude skills (slash commands)
+coreai skills generate
+
 # List available agents
 coreai agents list
 
 # Show details for a specific agent
 coreai agents show backend-engineer
+
+# Check agent status
+coreai status
 ```
 
 ## Commands
@@ -79,6 +88,42 @@ coreai agents show backend-engineer --json
 coreai agents show backend-engineer --markdown
 ```
 
+### `coreai status`
+
+Show agent states and pending messages.
+
+```bash
+# Show all agent states
+coreai status
+
+# Show detailed message information
+coreai status --detailed
+
+# Show status for a specific agent
+coreai status --agent backend-engineer
+
+# Initialize KnowledgeLibrary if not exists
+coreai status --init
+```
+
+### `coreai skills`
+
+Manage Claude skills (slash commands).
+
+```bash
+# Generate skills to .claude/commands/
+coreai skills generate
+
+# List available skills
+coreai skills list
+
+# Generate specific skills only
+coreai skills generate --skills implement-feature,create-pr
+
+# Overwrite existing skill files
+coreai skills generate --overwrite
+```
+
 ### Other Commands
 
 ```bash
@@ -88,16 +133,14 @@ coreai --version
 # Show help
 coreai --help
 
-# Validate configuration (coming soon)
+# Validate configuration
 coreai validate
 
-# Sync remote context (coming soon)
+# Sync remote context from configured sources
 coreai sync
+coreai sync --force  # Force refresh all cached content
 
-# Show project status (coming soon)
-coreai status
-
-# Cache management (coming soon)
+# Cache management
 coreai cache status
 coreai cache clear
 ```
@@ -210,27 +253,184 @@ description: "Backend engineer for ${config.project.name}"
 description: "I am ${agent.display_name}, responsible for ${agent.role}"
 ```
 
-### `${remote.*}` - Remote Content (Coming Soon)
+### `${remote.*}` - Remote Content
 
 ```yaml
 context:
   - "${remote.confluence.architecture-docs}"
 ```
 
+## Skills (Claude Slash Commands)
+
+CoreAI generates Claude Code slash commands that integrate with your project configuration.
+
+### Built-in Skills
+
+| Skill | Description |
+|-------|-------------|
+| `implement-feature` | Implement a feature following project workflow |
+| `create-pr` | Create a pull request with proper formatting |
+| `review-code` | Review code changes for quality and standards |
+| `run-quality-gates` | Run configured lint, test, and build commands |
+
+### Generating Skills
+
+```bash
+# Generate all skills
+coreai skills generate
+
+# List available skills
+coreai skills list
+
+# Generate to custom directory
+coreai skills generate --output ./my-commands
+```
+
+Generated skills are placed in `.claude/commands/` and become available as `/skill-name` in Claude Code.
+
+### Custom Skills
+
+Create custom skills in `coreai/skills/` directory:
+
+```markdown
+---
+name: deploy
+description: Deploy the application to staging
+category: custom
+---
+
+Deploy the application following the deployment checklist:
+
+1. Run all quality gates
+2. Build the production bundle
+3. Deploy to staging environment
+4. Run smoke tests
+```
+
+## MCP Server Integration
+
+CoreAI integrates with Model Context Protocol (MCP) servers for enhanced functionality.
+
+### Automatic Discovery
+
+The CLI automatically discovers MCP servers from:
+
+1. **Project-level**: `mcp.json`, `.mcp.json`, `.claude/mcp.json`
+2. **Global config**: `~/.config/claude/mcp.json`, `~/.claude/mcp.json`
+3. **Claude Desktop**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+
+### Supported MCP Servers
+
+| Server | Integration |
+|--------|-------------|
+| `@modelcontextprotocol/server-github` | GitHub issues, PRs, repositories |
+| `@anthropic/mcp-server-jira` | Jira issue tracking |
+| `@anthropic/mcp-server-confluence` | Confluence documentation |
+| `@modelcontextprotocol/server-filesystem` | Local file operations |
+
+### Configuration Example
+
+Create `.claude/mcp.json` in your project:
+
+```json
+{
+  "mcpServers": {
+    "github": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-github"],
+      "env": {
+        "GITHUB_TOKEN": "${GITHUB_TOKEN}"
+      }
+    },
+    "filesystem": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-filesystem", "./"]
+    }
+  }
+}
+```
+
+### Native Fallbacks
+
+When MCP servers are unavailable, CoreAI falls back to native adapters:
+
+- **GitHub**: Uses `gh` CLI or GitHub REST API
+- **Filesystem**: Direct file system operations
+
+## KnowledgeLibrary
+
+The KnowledgeLibrary provides persistent state management for agents.
+
+### Structure
+
+```
+KnowledgeLibrary/
+├── context.txt              # Project context
+├── architecture.txt         # Architecture overview
+├── prd.txt                  # Product requirements
+└── backend-engineer/        # Per-agent directories
+    ├── inbox/               # Incoming messages
+    │   └── processed/       # Processed messages
+    ├── outbox/              # Outgoing messages
+    ├── context/             # Agent-specific context
+    │   └── current.txt      # Current working state
+    ├── control/             # Control files
+    │   ├── objectives.txt   # Current objectives
+    │   ├── decisions.txt    # Key decisions
+    │   └── dependencies.txt # Dependencies
+    ├── history/             # Historical records
+    └── tech/                # Technical notes
+```
+
+### Initializing
+
+```bash
+# Initialize during build
+coreai build --init-knowledge-library
+
+# Or initialize separately
+coreai status --init
+```
+
+### Checking Status
+
+```bash
+# View all agents
+coreai status
+
+# Detailed view with messages
+coreai status --detailed
+
+# JSON output for scripting
+coreai status --json
+```
+
 ## Project Structure
 
 ```
 your-project/
 ├── coreai.config.yaml          # Project configuration
 ├── coreai/
-│   └── agents/                 # Custom agent definitions
-│       └── my-agent.yaml
+│   ├── agents/                 # Custom agent definitions
+│   │   └── my-agent.yaml
+│   └── skills/                 # Custom skill templates
+│       └── my-skill.md
 ├── .claude/
-│   └── agents/                 # Compiled agents (generated)
-│       ├── backend-engineer.md
-│       └── my-agent.md
-└── .coreai/
-    └── cache/                  # Local cache (coming soon)
+│   ├── mcp.json                # MCP server configuration
+│   ├── agents/                 # Compiled agents (generated)
+│   │   ├── backend-engineer.md
+│   │   └── my-agent.md
+│   └── commands/               # Generated skills (slash commands)
+│       ├── implement-feature.md
+│       └── create-pr.md
+├── .coreai/
+│   └── cache/                  # Remote content cache
+└── KnowledgeLibrary/           # Agent state management
+    ├── context.txt
+    └── backend-engineer/
+        ├── inbox/
+        ├── outbox/
+        └── context/
 ```
 
 ## Development
@@ -244,7 +444,7 @@ your-project/
 
 ```bash
 # Clone the repository
-git clone https://github.com/your-org/coreai.git
+git clone https://github.com/DeimosCloud/coreai.git
 cd coreai
 
 # Install dependencies
@@ -278,25 +478,27 @@ npm run test:watch
 
 See [IMPLEMENTATION_PLAN.md](IMPLEMENTATION_PLAN.md) for detailed implementation status.
 
-### Completed
+### Phase 1 (Complete)
 
 - Project foundation (TypeScript, CLI, configuration)
 - Agent YAML schema and validation
 - Variable resolution system
 - Agent compiler (YAML to Markdown)
 - Agent CLI commands (build, list, show)
-
-### In Progress
-
 - Integration adapter framework
-- MCP integration layer
+- MCP integration layer with server discovery
+- Shared context and caching
+- Skill generation (Claude slash commands)
+- KnowledgeLibrary (local agent state management)
+- Complete CLI binary
 
-### Planned
+### Phase 2 (Planned)
 
-- Shared context and caching
-- Remote content fetching
-- Skill generation
-- Local state management
+- Real-time agent collaboration
+- Advanced MCP server integrations
+- Remote context syncing with Confluence/Notion
+- Agent workflow orchestration
+- Multi-project support
 
 ## License