bugpatrol 0.0.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,36 @@
1
- # bugpatrol
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/agent-labs-dev/bugpatrol/main/assets/banner.png" alt="Bugpatrol: AI agents that explore your app, find bugs, and fix them." width="100%">
3
+ </p>
2
4
 
3
- This name is reserved for Bughunters. The package has no code yet.
5
+ Bugpatrol is a QA team made of agents. It uses your web, Electron, iOS, or Android app the way a tester does. It finds bugs, fixes them, checks each fix in the running app, and opens the pull requests and issues for your team.
6
+
7
+ ```sh
8
+ npx bugpatrol init # find the app and the LLMs, and write .bugpatrol/
9
+ npx bugpatrol # explore, judge, fix, retest, and publish, again and again
10
+ npx bugpatrol dashboard # look at the results on http://127.0.0.1:4311
11
+ ```
12
+
13
+ ## Set up with your agent
14
+
15
+ Install the skill for your coding agent, then ask the agent to "set up Bugpatrol for this repo":
16
+
17
+ ```bash
18
+ npx skills add agent-labs-dev/bugpatrol
19
+ ```
20
+
21
+ If your agent cannot install skills, give it the skill URL:
22
+
23
+ ```text
24
+ Read https://raw.githubusercontent.com/agent-labs-dev/bugpatrol/main/skills/bugpatrol/SKILL.md and set up Bugpatrol for this repo.
25
+ ```
26
+
27
+ ## Documentation
28
+
29
+ - [README](https://github.com/agent-labs-dev/bugpatrol#readme)
30
+ - [Getting started](https://github.com/agent-labs-dev/bugpatrol/blob/main/docs/getting-started.md)
31
+ - [Configuration](https://github.com/agent-labs-dev/bugpatrol/blob/main/docs/configuration.md)
32
+ - [Commands](https://github.com/agent-labs-dev/bugpatrol/blob/main/docs/commands.md)
33
+
34
+ The [Nebula](https://nebula.gg) team uses Bugpatrol to test its own apps, and made it open source for all teams.
35
+
36
+ Made with ❤️ by the [Nebula](https://nebula.gg) team. Apache-2.0.