Metadata-Version: 2.4
Name: bugx-agent
Version: 0.9.15
Summary: Host-neutral adversarial white-box and black-box auditing agent
License-Expression: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: tui
Requires-Dist: pexpect==4.9.0; extra == "tui"
Provides-Extra: graph
Requires-Dist: tree-sitter-language-pack==1.14.3; extra == "graph"
Dynamic: license-file

# BugX

> **Version 0.9.15**

BugX 是一个给 AI 编程宿主使用的 Bug 审计 Agent。它负责规划测试、检查证据、确认问题并生成报告；真正的代码阅读和命令执行仍由 AI 宿主完成。

## 使用

准备好 `bugx` 命令后，进入要审计的项目目录，发现可用的 AI 宿主并启用 BugX：

```bash
bugx agent discover --root . --json
bugx install --root .
```

也可以指定宿主：

```bash
bugx install --root . \
  --agent opencode --agent codex --agent claude --agent cline \
  --agent zcode --agent pi --non-interactive
```

安装后，在对应宿主中选择 `BugX`，然后让它审计当前项目。例如：

- OpenCode：输入 `@bugx`
- Claude Code：选择 `bugx` Agent
- Codex：选择 `bugx` Skill
- Pi：使用 `.pi/skills/bugx/SKILL.md`

## 常用命令

```bash
# 检查安装
bugx doctor --root . --installation-only

# 启动本地 MCP Supervisor（宿主需要时使用）
bugx mcp serve --root . --role host

# 查看帮助和版本
bugx --help
bugx --version
```

审计结果和运行状态默认保存在项目的 `.bugx/` 目录中。不要把其中可能包含项目代码片段的文件提交到公开仓库。

## 卸载

只移除当前项目中的 BugX：

```bash
bugx uninstall --root .
```

执行前可先用 `--dry-run` 查看将要删除的内容。

## 开发

每次提交代码都必须同步更新受影响文档并递增补丁版本；需要跨补丁版本变更时，显式使用 `--confirm-version-transition`。

```bash
python3 -m unittest -q tests.test_jenkinsfile tests.test_consistency
python3 scripts/bump_version.py --check
```
