omniqa 0.1.1 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +75 -0
  2. package/package.json +7 -7
package/README.md ADDED
@@ -0,0 +1,75 @@
1
+ # OmniQA
2
+
3
+ OmniQA is an AI-first testing tool. Point it at your product (the site, the repositories, the docs) and its agent
4
+ interviews you, learns how the product works, plans the tests with you, writes them as plain-English tests on top of its
5
+ own browser driver (Chrome for Testing over the DevTools protocol), runs them on its own runner, and keeps the knowledge
6
+ and the tests current as the product changes.
7
+
8
+ - **Agentic tests.** Steps are written the way a user acts (`agent.do("click Add to cart")`); a model finds the element
9
+ in a screenshot of the page, and code confirms it is really there at that point before acting, so there are no
10
+ selectors to maintain. API tests stay deterministic.
11
+ - **A product knowledge base.** Built from your code, your docs and the running product, reviewed by a second model,
12
+ and used by every agent.
13
+ - **Self-maintaining.** A product change on GitHub or GitLab updates the knowledge and the affected tests; heals and
14
+ fixes arrive as a commit or a merge request, each judged by a reviewer model.
15
+ - **Web and native.** Desktop and mobile browsers through OmniQA's own driver on Chrome for Testing (phones by emulation,
16
+ or the real Chrome of an Android device over adb), stock Firefox over WebDriver BiDi (optional), Safari on an iOS simulator,
17
+ and iOS, Android, macOS and Linux apps through [agent-device](https://github.com/callstack/agent-device).
18
+ - **Your models.** Anthropic or any OpenAI-compatible provider (OpenRouter, a local server), with your own key; the model
19
+ that runs the steps must read images.
20
+
21
+ A test OmniQA writes:
22
+
23
+ ```ts
24
+ import { test, expect } from "omniqa/test";
25
+
26
+ test("cart-1: A guest adds a widget to the cart", { tag: ["@P0", "@dev"] }, async ({ page, agent }) => {
27
+ await page.goto("/");
28
+ await agent.do("click the Add to cart button");
29
+ await agent.assert("the cart shows 1 item");
30
+ await expect(page).toHaveURL((url) => url.pathname === "/");
31
+ });
32
+ ```
33
+
34
+ ## Install
35
+
36
+ Node.js 26.6 or later and git. A model key: Anthropic (`ANTHROPIC_API_KEY`) or an OpenAI-compatible provider such as
37
+ OpenRouter (`OPENROUTER_API_KEY`).
38
+
39
+ ```bash
40
+ npm install -g omniqa
41
+ omniqa install # the Chrome for Testing build OmniQA pins (Linux: --with-deps adds its libraries)
42
+ omniqa doctor # checks this machine; exit code 0 means ready
43
+ ```
44
+
45
+ ## Start a project
46
+
47
+ One folder per product, usually a `qa/` folder in the product's repository or a repository of its own:
48
+
49
+ ```bash
50
+ omniqa init shop-qa # creates the folder (and a git repository in it) and asks about your product
51
+ cd shop-qa
52
+ cp .env.example .env # the model key and the test accounts go here, never in git
53
+ omniqa plan # the test plan, its reviewer, your approval on a page in your browser
54
+ omniqa knowledge build # the knowledge base
55
+ omniqa write --priority P0 # write the P0 tests
56
+ omniqa test # run them
57
+ omniqa coverage # what is covered, as a tree
58
+ omniqa chat # ask the QA agent anything about it
59
+ ```
60
+
61
+ `omniqa init` without a folder runs the stages in one go: the interview, the plan, the knowledge base, the writer. Run it
62
+ again and it resumes where it stopped.
63
+
64
+ ## Documentation
65
+
66
+ - [README on GitHub](https://github.com/iaros-iaros/omniqa#readme): how it works, cost, and using it on your product.
67
+ - [Install guide](https://github.com/iaros-iaros/omniqa/blob/main/docs/install.md): every step with the expected output, on a sample shop, then your product.
68
+ - [Reference](https://github.com/iaros-iaros/omniqa/blob/main/docs/reference.md): every command, file and switch.
69
+ - [Devices](https://github.com/iaros-iaros/omniqa/blob/main/docs/devices.md): mobile browsers, simulators, emulators and native apps.
70
+ - [Issues](https://github.com/iaros-iaros/omniqa/issues).
71
+
72
+ The CLI, the test SDK (`omniqa/test`) and the MCP server live in this package; `@omniqa/core`, `@omniqa/browser`,
73
+ `@omniqa/web`, `@omniqa/device`, `@omniqa/github` and `@omniqa/gitlab` are its parts and come with it.
74
+
75
+ Apache-2.0.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "omniqa",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "OmniQA: agentic test framework and product knowledge base. SDK, runner and CLI.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -42,11 +42,11 @@
42
42
  }
43
43
  },
44
44
  "dependencies": {
45
- "@omniqa/browser": "^0.1.1",
46
- "@omniqa/core": "^0.1.1",
47
- "@omniqa/device": "^0.1.1",
48
- "@omniqa/github": "^0.1.1",
49
- "@omniqa/gitlab": "^0.1.1",
50
- "@omniqa/web": "^0.1.1"
45
+ "@omniqa/browser": "^0.1.2",
46
+ "@omniqa/core": "^0.1.2",
47
+ "@omniqa/device": "^0.1.2",
48
+ "@omniqa/github": "^0.1.2",
49
+ "@omniqa/gitlab": "^0.1.2",
50
+ "@omniqa/web": "^0.1.2"
51
51
  }
52
52
  }