@bugzy-ai/bugzy 1.2.0 → 1.3.0

package/README.md

@@ -1,17 +1,27 @@
 # Bugzy
 
-[![npm version](https://img.shields.io/npm/v/bugzy.svg)](https://www.npmjs.com/package/bugzy)
+[![npm version](https://img.shields.io/npm/v/@bugzy-ai/bugzy.svg)](https://www.npmjs.com/package/@bugzy-ai/bugzy)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![Node Version](https://img.shields.io/node/v/bugzy.svg)](https://nodejs.org)
+[![Node Version](https://img.shields.io/node/v/@bugzy-ai/bugzy.svg)](https://nodejs.org)
 
-> Open-source AI agent configuration for QA automation with Claude Code
+> Open-source AI agent configuration for QA automation
 
-Bugzy is a CLI tool that manages AI agent configuration and starts Claude Code sessions with properly configured subagents, tasks, and MCP servers for test automation.
+Bugzy is a CLI tool that manages AI agent configuration for your AI coding assistant, providing properly configured subagents, tasks, and MCP servers for test automation.
+
+## Supported Tools
+
+| Tool | Status | Description |
+|------|--------|-------------|
+| **Claude Code** | Recommended | Anthropic's official CLI - full feature support |
+| **Cursor** | Experimental | VS Code-based AI editor |
+| **Codex CLI** | Experimental | OpenAI's terminal-based agent |
+
+> **Note**: Cursor and Codex support is experimental. Some features may not work as expected. Claude Code is the recommended and fully tested option.
 
 ## Features
 
-- ✅ **Complete Task Library** - 8 pre-built QA automation tasks
-- ✅ **Flexible Subagents** - Test Runner, Team Communicator, Documentation Researcher, Issue Tracker
+- ✅ **Complete Task Library** - 7 pre-built QA automation tasks
+- ✅ **Flexible Subagents** - Test Runner, Test Code Generator, Test Debugger & Fixer, Team Communicator, Documentation Researcher, Issue Tracker
 - ✅ **Easy Setup** - Interactive CLI configuration (`bugzy setup`)
 - ✅ **Local Execution** - Runs entirely on your machine with Claude Code
 - ✅ **Version Control Friendly** - Configuration stored in git-friendly files
@@ -23,7 +33,7 @@ Bugzy is a CLI tool that manages AI agent configuration and starts Claude Code s
 
 ```bash
 # Install globally
-npm install -g bugzy
+npm install -g @bugzy-ai/bugzy
 
 # Navigate to your project
 cd my-project
@@ -61,40 +71,43 @@ After running `bugzy setup`, your project will have:
 ```
 your-project/
 ├── .bugzy/
-│   ├── config.json              # Your subagent configuration
+│   ├── config.json              # Your subagent configuration (includes selected tool)
 │   └── runtime/
 │       ├── project-context.md   # Project information
 │       └── templates/           # Customizable templates
-├── .claude/
-│   ├── commands/                # 8 task slash commands
+├── .<tool>/                     # Tool-specific directory (.claude/, .cursor/, or .codex/)
+│   ├── commands/                # Task commands (or prompts/ for Codex)
 │   ├── agents/                  # Configured subagent prompts
-│   └── .mcp.json                # MCP server configuration
+│   └── mcp.json                 # MCP server configuration
 ├── .env.example                 # MCP secrets template (empty values)
 ├── .env.testdata                # Test data with actual values (from /generate-test-plan)
 └── .env                         # Your actual secrets (gitignored)
 ```
 
+> **Note**: The directory structure varies by tool. Claude Code uses `.claude/`, Cursor uses `.cursor/`, and Codex uses `.codex/`.
+
 ## Available Subagents
 
 | Subagent | Purpose | Integrations | Required |
 |----------|---------|--------------|----------|
-| **Test Runner** | Execute automated tests | Playwright | ✅ Yes |
-| **Team Communicator** | Send team notifications | Slack | ❌ Optional |
+| **Test Runner** | Execute automated browser tests | Playwright | ✅ Yes |
+| **Test Code Generator** | Generate Playwright test scripts and Page Objects | Playwright | ✅ Yes |
+| **Test Debugger & Fixer** | Debug and fix failing tests automatically | Playwright | ✅ Yes |
+| **Team Communicator** | Send team notifications | Slack, Microsoft Teams | ❌ Optional |
 | **Documentation Researcher** | Search documentation | Notion, Confluence | ❌ Optional |
-| **Issue Tracker** | Create and track bugs | Linear, Jira, Notion, Slack | ❌ Optional |
+| **Issue Tracker** | Create and track bugs | Linear, Jira Cloud, Jira Server, Notion, Slack | ❌ Optional |
 
 ## Available Tasks
 
 | Task | Command | Description |
 |------|---------|-------------|
+| Explore Application | `/explore-application` | Explore and document application features |
 | Generate Test Plan | `/generate-test-plan` | Create comprehensive test plans |
 | Generate Test Cases | `/generate-test-cases` | Generate executable test cases |
-| Explore Application | `/explore-application` | Document application features |
-| Run Tests | `/run-tests` | Execute automated tests |
-| Verify Changes (Manual) | `/verify-changes-manual` | Verify changes locally |
-| Verify Changes (Slack) | `/verify-changes-slack` | Verify and notify team |
-| Handle Message | `/handle-message` | Process team messages |
-| Process Event | `/process-event` | Handle automated events |
+| Run Tests | `/run-tests` | Execute automated tests and analyze failures |
+| Verify Changes | `/verify-changes` | Verify product changes via automated testing |
+| Handle Message | `/handle-message` | Process team messages from Slack/Teams |
+| Process Event | `/process-event` | Handle automated webhooks and events |
 
 ## Configuration
 
@@ -103,6 +116,7 @@ Bugzy uses a simple configuration format:
 ```json
 {
   "version": "1.0.0",
+  "tool": "claude-code",
   "project": {
     "name": "my-project"
   },
@@ -115,6 +129,8 @@ Bugzy uses a simple configuration format:
 }
 ```
 
+The `tool` field can be `"claude-code"` (default), `"cursor"` (experimental), or `"codex"` (experimental).
+
 **Don't edit `config.json` manually** - use `bugzy setup` to reconfigure.
 
 ## Environment Variables
@@ -152,7 +168,10 @@ Check out example configurations:
 ## Requirements
 
 - **Node.js** v18 or higher
-- **Claude Code** installed and configured
+- **AI Coding Tool**: One of the following installed and configured:
+  - **Claude Code** (recommended) - Anthropic's official CLI
+  - **Cursor** (experimental) - VS Code-based AI editor
+  - **Codex CLI** (experimental) - OpenAI's terminal-based agent
 - **npm** or **yarn** package manager
 
 ## Breaking Changes (v0.2.0)
@@ -199,7 +218,7 @@ Bugzy will detect your existing configuration and allow you to make changes.
 ### Command Not Found
 
 ```bash
-npm install -g bugzy
+npm install -g @bugzy-ai/bugzy
 ```
 
 ### Missing Secrets
@@ -210,9 +229,12 @@ npm install -g bugzy
 
 Add the missing secret to your `.env` file.
 
-### Claude Code Not Found
+### AI Tool Not Found
 
-Install Claude Code and ensure it's in your PATH.
+Install your selected AI coding tool and ensure it's in your PATH:
+- **Claude Code**: Install from [claude.ai/code](https://claude.ai/code)
+- **Cursor**: Install from [cursor.com](https://cursor.com)
+- **Codex CLI**: Install from [OpenAI](https://github.com/openai/codex)
 
 See the [Getting Started Guide](./docs/getting-started.md) for more troubleshooting tips.
 
@@ -231,7 +253,7 @@ A: In `.env` which is gitignored. `.env.example` (MCP secrets template) and `.en
 A: You can customize templates in `.bugzy/runtime/templates/`.
 
 **Q: How do I update to get new tasks?**
-A: Run `npm update -g bugzy && bugzy setup`
+A: Run `npm update -g @bugzy-ai/bugzy && bugzy setup`
 
 ## License
 
@@ -243,6 +265,6 @@ Contributions are welcome! Please read our contributing guidelines (coming soon)
 
 ## Support
 
-- **Issues**: [github.com/bugzy-ai/bugzy-oss/issues](https://github.com/bugzy-ai/bugzy-oss/issues)
-- **Discussions**: [github.com/bugzy-ai/bugzy-oss/discussions](https://github.com/bugzy-ai/bugzy-oss/discussions)
+- **Issues**: [github.com/bugzy-ai/bugzy/issues](https://github.com/bugzy-ai/bugzy/issues)
+- **Discussions**: [github.com/bugzy-ai/bugzy/discussions](https://github.com/bugzy-ai/bugzy/discussions)
 - **Documentation**: [docs.bugzy.dev](https://docs.bugzy.dev)