ordel-cli 0.1.0__tar.gz

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.
@@ -0,0 +1,175 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ *.egg-info/
6
+ dist/
7
+ build/
8
+ .eggs/
9
+ *.egg
10
+ .venv/
11
+ venv/
12
+
13
+ # Runtime
14
+ .ordel/
15
+
16
+ # IDE
17
+ .vscode/
18
+ .idea/
19
+ *.swp
20
+ *.swo
21
+
22
+ # OS
23
+ .DS_Store
24
+ Thumbs.db
25
+
26
+ # Environment
27
+ .env
28
+ .env.*
29
+ !.env.example
30
+ !.env.prod.example
31
+
32
+ # Terraform
33
+ **/.terraform/*
34
+ *.tfstate
35
+ *.tfstate.*
36
+ *.tfvars
37
+ !*.tfvars.example
38
+ tfplan
39
+ *.tfplan
40
+ crash.log
41
+ crash.*.log
42
+
43
+ # Stray root-level node_modules (e.g. an npm install run from the repo root,
44
+ # or the rrweb-dom-stream poc pulling deps up) — never committed.
45
+ /node_modules/
46
+ # Local trace-capture scratch (Langfuse/OTel dumps) — throwaway.
47
+ /scratchpad_traces/
48
+
49
+ # Node (web/)
50
+ web/node_modules/
51
+ web/.next/
52
+ # Stale build caches moved aside during repairs (e.g. the Kestrel→Ordel
53
+ # rename Turbopack fix). Local-only, safe to delete.
54
+ web/.next.*/
55
+ web/out/
56
+ web/.pnp
57
+ web/.pnp.*
58
+ # TypeScript incremental build cache — local-only, regenerates on each build.
59
+ web/tsconfig.tsbuildinfo
60
+
61
+ # Node runner (node-runner/) — local Playwright run output
62
+ node-runner/runs/
63
+ node-runner/node_modules/
64
+
65
+ # Testing
66
+ .coverage
67
+ htmlcov/
68
+ .pytest_cache/
69
+ .ruff_cache/
70
+ .mypy_cache/
71
+ test-results/
72
+ web/test-results/
73
+ web/playwright-report/
74
+ backend/test-results/
75
+
76
+ # Playwright
77
+ .playwright-cli/
78
+ .playwright-mcp/
79
+ .playwright/
80
+
81
+ # storageState files — contain live auth tokens; regenerated each run
82
+ web/tests/.auth/
83
+ web/**/.auth/
84
+
85
+ # Worktrees
86
+ .worktrees/
87
+
88
+ # Brainstorm sessions
89
+ .superpowers/
90
+
91
+ # Claude Code config
92
+ .claude.json
93
+ .claude/worktrees/
94
+ *.debug
95
+
96
+ # Backups (local only)
97
+ backups/
98
+
99
+ # Local dev notes (credentials, scratch)
100
+ draft-keep.txt
101
+
102
+ # Binary artifacts
103
+ *.docx
104
+
105
+ # Test artifacts (manual playtest screenshots + recorder session captures)
106
+ # Live snapshots end up next to whatever directory the tester ran from;
107
+ # pin specific names rather than a blanket *.png so legit UI assets in
108
+ # web/public/ + docs/ don't get caught.
109
+ /*.png
110
+ /web/*.png
111
+ /backend/*.png
112
+ /qa-suite/modules/_session-*.spec.ts
113
+ /backend/bugs.md
114
+
115
+ # Backend runtime artifact storage (POM persist / local-FS dev mirror)
116
+ /backend/storage/
117
+
118
+ # Archived docs (historical plans, sessions, completed milestones — not for review)
119
+ docs/archive/
120
+
121
+ # =============================================================
122
+ # Reference / experimental code (kept locally, not in repo)
123
+ # =============================================================
124
+
125
+ # Performance testing reference implementation (Phase 2)
126
+ Perf_Flow/
127
+ Perf_Flow.zip
128
+
129
+ # Archived v1 components (replaced by v2)
130
+ web/components/scripts/archived/
131
+
132
+ # Unused shared components (experimental)
133
+ web/components/shared/approval-batch.tsx
134
+ web/components/shared/coverage-ring.tsx
135
+ web/components/shared/inline-approval.tsx
136
+ web/components/shared/onboarding-tour.tsx
137
+
138
+ # Unused studio components (experimental)
139
+ web/components/studio/ArtifactCard.tsx
140
+ web/components/studio/BrowserPreview.tsx
141
+ web/components/studio/NewSessionModal.tsx
142
+
143
+ # Unused layout components (replaced)
144
+ web/components/layout/app-sidebar.tsx
145
+ web/components/layout/header.tsx
146
+ .claude/scheduled_tasks.lock
147
+
148
+ # =============================================================
149
+ # Per-developer tool output (regenerable, don't commit)
150
+ # =============================================================
151
+
152
+ # Antigravity CLI: home-dir symlinks to ~/.gemini/config/projects/*
153
+ .antigravitycli/
154
+
155
+ # Understand-Anything: knowledge graph cache (regenerate with /understand)
156
+ # Keep the .understandignore input config so all devs share the same graph scope.
157
+ .understand-anything/*
158
+ !.understand-anything/.understandignore
159
+
160
+ # Local install / runtime logs (uvicorn, npm, pip, alembic, bootstrap, etc.)
161
+ *.log
162
+ *.err
163
+ backend/.secrets/
164
+ *.pem
165
+ .secrets/
166
+
167
+ # Workflow/agent scratch scripts (throwaway)
168
+ .wf-*
169
+ backend/.wf-*
170
+
171
+ # Stale: web/e2e was renamed to web/tests long ago — keep the leftover out
172
+ web/e2e/
173
+ docs/conference/demo-video/
174
+ scratchpad-video/
175
+ .overmind.env
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ Metadata-Version: 2.4
2
+ Name: ordel-cli
3
+ Version: 0.1.0
4
+ Summary: Ordel free CLI — local QA-automation for individual devs. Drives the deterministic ordel-engine and exposes it to a BYO coding agent over MCP. No account, no DB, no Ordel LLM.
5
+ Project-URL: Homepage, https://ordel.io
6
+ Author: Ordel
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Keywords: coding-agent,mcp,page-object,playwright,qa,self-healing,testing
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Topic :: Software Development :: Testing
15
+ Requires-Python: >=3.11
16
+ Requires-Dist: mcp>=1.0
17
+ Requires-Dist: ordel-engine==0.1.0
18
+ Requires-Dist: typer>=0.12
19
+ Provides-Extra: dev
20
+ Requires-Dist: pytest>=8; extra == 'dev'
21
+ Description-Content-Type: text/markdown
22
+
23
+ # ordel (free CLI)
24
+
25
+ Local QA automation for individual devs — a persistent, deterministic "QA brain" your
26
+ own coding agent (Claude Code / Cursor / Copilot) drives over MCP. **No account, no DB,
27
+ no Ordel LLM.** Your agent is the brain; Ordel is the memory + determinism.
28
+
29
+ > Status: **early build**. The engine loop (map → record → generate → run) works
30
+ > locally today; packaged `npx ordel` distribution is the remaining in-progress piece —
31
+ > see `docs/plans/2026-07-17-free-cli-implementation-plan.md`.
32
+
33
+ ## What works today (local, anonymous)
34
+
35
+ ```bash
36
+ ordel init # create .ordel/ + an ORDEL.md bridge file. No account.
37
+ ordel doctor # preflight: Node / npx / @playwright/test / Chromium (+ how to fix)
38
+ ordel status # local coverage: pages, elements, run history
39
+ ordel graph # print the local app graph
40
+ ordel report # copy-pasteable Markdown report (Slack/Teams/Jira)
41
+ ordel mcp-install # print the MCP config to add to Claude Code / Cursor / Copilot
42
+ ```
43
+
44
+ Then your coding agent, via MCP, drives the loop (needs Node + `@playwright/test` in the
45
+ project — run `ordel doctor` to check):
46
+ - `get_app_context` / `heal_selector` — what Ordel knows + **deterministic self-heal**
47
+ of a broken selector (fingerprint match, no LLM; ambiguous cases return `needs_agent`
48
+ with ranked candidates for your agent's *own* LLM to resolve — Ordel never spends inference).
49
+ - `explore` / `record_flow` — drive the real browser to map the app + record a flow.
50
+ - `generate_scenarios` / `generate_invariant` / `generate_perf_check` / `generate_pom` —
51
+ turn artifacts into runnable specs (happy/negative/boundary, data-integrity, latency, POM).
52
+ - `run_test` — run a spec via `npx playwright test` and read the real pass/fail.
53
+ - QA-mind planning: `coverage_report` / `risk_rank` / `plan_tests` / `regression_set`.
54
+
55
+ ## In progress (honest — no fake success)
56
+
57
+ - Single `npx ordel` distribution — a compiled Python engine binary wrapped in one npm
58
+ package (built + smoke-tested in CI; `npm/` here is the wrapper).
59
+ - `eject` (one-command raw-Playwright export) — scaffold; but there's no lock-in today
60
+ either: generated tests are already plain `tests/*.spec.ts` + `pages/*.ts` on disk.
61
+ - Team sync + hosted dashboard = the paid upgrade (this CLI stays free & local).
62
+
63
+ ## The pieces
64
+
65
+ - **`ordel-engine`** (sibling package) — the pure deterministic core: fingerprint
66
+ matching + self-heal, stdlib-only, zero backend.
67
+ - **`ordel_cli.store`** — the `.ordel/` file store (the local shell).
68
+ - **`ordel_cli.heal_service`** — heal + per-page circuit-breaker.
69
+ - **`ordel_cli.mcp_server`** — the local stdio MCP server your agent connects to.
70
+
71
+ ## Dev
72
+
73
+ ```bash
74
+ pip install -e packages/ordel-engine -e packages/ordel-cli
75
+ pip install pytest
76
+ pytest packages/ordel-cli/tests packages/ordel-engine/tests -q
77
+ ```
78
+
79
+ ## Known limitations (by design)
80
+
81
+ - **Single-writer.** The `.ordel/` store is for one dev on one machine. Writes are
82
+ *atomic* (temp-file + `os.replace`, so a crash can't corrupt a file), and a corrupted
83
+ `graph.json` is reported cleanly (never silently overwritten). But two processes
84
+ writing the *same* page concurrently is last-writer-wins — there is no file lock. That
85
+ is deliberate: a single-user local CLI doesn't warrant lock files / their failure
86
+ modes. Team-scale concurrency is the hosted product's job (`ordel push`).
87
+ - **Browser tools need a local Node + `@playwright/test`** (`explore`/`record_flow`/`run_test`).
88
+ They don't ship a browser; run `ordel doctor` — if Node/Playwright/Chromium are missing it
89
+ tells you the exact command to fix. Without them these tools report the missing dependency,
90
+ never fake success.
91
+
92
+ ## Privacy
93
+
94
+ Local-first: **no Ordel LLM, no telemetry, no account, no data sent to Ordel.** The only
95
+ network requests are to your own target app and standard package/browser downloads you
96
+ initiate. See [PRIVACY.md](PRIVACY.md).
@@ -0,0 +1,31 @@
1
+ # Privacy
2
+
3
+ **The Ordel free CLI is local-first and sends nothing about you or your app to Ordel.**
4
+
5
+ ## What it does on your machine
6
+ - Reads and writes a local `.ordel/` directory (your app map, recorded flows, run history)
7
+ and generates plain Playwright test files under `tests/` and `pages/`.
8
+ - Drives **your own browser** via your project's Playwright to explore/record/run tests
9
+ against **the target apps you point it at** (the URLs you provide).
10
+ - Runs entirely on your machine over stdio when your coding agent spawns it as an MCP server.
11
+
12
+ ## What it does NOT do
13
+ - **No Ordel LLM.** The engine is deterministic (fingerprint matching + self-heal). It never
14
+ calls an Ordel model. Your coding agent uses its **own** LLM; Ordel spends zero inference.
15
+ - **No telemetry, no analytics, no account.** The CLI does not phone home. There is no
16
+ usage tracking and no data is sent to Ordel or any third party.
17
+ - **No egress to Ordel.** The only network requests made are to (a) **your own target app**
18
+ (the URLs you give it) and (b) standard package/browser downloads you initiate yourself:
19
+ `uv`/`pip` fetching this package from PyPI, and Playwright downloading its browser from
20
+ Microsoft's CDN via `playwright install`. None of these involve Ordel.
21
+
22
+ ## Credentials
23
+ - If you save a login (`save_auth`), session cookies + local storage are written to
24
+ `.ordel/state.json` on your machine (file mode `0600`) and used only to skip re-login on
25
+ your target app. Basic-auth credentials are stripped from any URL before it is stored or
26
+ written into a generated test.
27
+
28
+ ## The paid, hosted Ordel (separate product)
29
+ This document covers the **free, local CLI** only. The hosted Ordel SaaS is a separate,
30
+ account-based product with its own terms and privacy policy; nothing in this CLI connects to
31
+ it unless you explicitly opt in.
@@ -0,0 +1,74 @@
1
+ # ordel (free CLI)
2
+
3
+ Local QA automation for individual devs — a persistent, deterministic "QA brain" your
4
+ own coding agent (Claude Code / Cursor / Copilot) drives over MCP. **No account, no DB,
5
+ no Ordel LLM.** Your agent is the brain; Ordel is the memory + determinism.
6
+
7
+ > Status: **early build**. The engine loop (map → record → generate → run) works
8
+ > locally today; packaged `npx ordel` distribution is the remaining in-progress piece —
9
+ > see `docs/plans/2026-07-17-free-cli-implementation-plan.md`.
10
+
11
+ ## What works today (local, anonymous)
12
+
13
+ ```bash
14
+ ordel init # create .ordel/ + an ORDEL.md bridge file. No account.
15
+ ordel doctor # preflight: Node / npx / @playwright/test / Chromium (+ how to fix)
16
+ ordel status # local coverage: pages, elements, run history
17
+ ordel graph # print the local app graph
18
+ ordel report # copy-pasteable Markdown report (Slack/Teams/Jira)
19
+ ordel mcp-install # print the MCP config to add to Claude Code / Cursor / Copilot
20
+ ```
21
+
22
+ Then your coding agent, via MCP, drives the loop (needs Node + `@playwright/test` in the
23
+ project — run `ordel doctor` to check):
24
+ - `get_app_context` / `heal_selector` — what Ordel knows + **deterministic self-heal**
25
+ of a broken selector (fingerprint match, no LLM; ambiguous cases return `needs_agent`
26
+ with ranked candidates for your agent's *own* LLM to resolve — Ordel never spends inference).
27
+ - `explore` / `record_flow` — drive the real browser to map the app + record a flow.
28
+ - `generate_scenarios` / `generate_invariant` / `generate_perf_check` / `generate_pom` —
29
+ turn artifacts into runnable specs (happy/negative/boundary, data-integrity, latency, POM).
30
+ - `run_test` — run a spec via `npx playwright test` and read the real pass/fail.
31
+ - QA-mind planning: `coverage_report` / `risk_rank` / `plan_tests` / `regression_set`.
32
+
33
+ ## In progress (honest — no fake success)
34
+
35
+ - Single `npx ordel` distribution — a compiled Python engine binary wrapped in one npm
36
+ package (built + smoke-tested in CI; `npm/` here is the wrapper).
37
+ - `eject` (one-command raw-Playwright export) — scaffold; but there's no lock-in today
38
+ either: generated tests are already plain `tests/*.spec.ts` + `pages/*.ts` on disk.
39
+ - Team sync + hosted dashboard = the paid upgrade (this CLI stays free & local).
40
+
41
+ ## The pieces
42
+
43
+ - **`ordel-engine`** (sibling package) — the pure deterministic core: fingerprint
44
+ matching + self-heal, stdlib-only, zero backend.
45
+ - **`ordel_cli.store`** — the `.ordel/` file store (the local shell).
46
+ - **`ordel_cli.heal_service`** — heal + per-page circuit-breaker.
47
+ - **`ordel_cli.mcp_server`** — the local stdio MCP server your agent connects to.
48
+
49
+ ## Dev
50
+
51
+ ```bash
52
+ pip install -e packages/ordel-engine -e packages/ordel-cli
53
+ pip install pytest
54
+ pytest packages/ordel-cli/tests packages/ordel-engine/tests -q
55
+ ```
56
+
57
+ ## Known limitations (by design)
58
+
59
+ - **Single-writer.** The `.ordel/` store is for one dev on one machine. Writes are
60
+ *atomic* (temp-file + `os.replace`, so a crash can't corrupt a file), and a corrupted
61
+ `graph.json` is reported cleanly (never silently overwritten). But two processes
62
+ writing the *same* page concurrently is last-writer-wins — there is no file lock. That
63
+ is deliberate: a single-user local CLI doesn't warrant lock files / their failure
64
+ modes. Team-scale concurrency is the hosted product's job (`ordel push`).
65
+ - **Browser tools need a local Node + `@playwright/test`** (`explore`/`record_flow`/`run_test`).
66
+ They don't ship a browser; run `ordel doctor` — if Node/Playwright/Chromium are missing it
67
+ tells you the exact command to fix. Without them these tools report the missing dependency,
68
+ never fake success.
69
+
70
+ ## Privacy
71
+
72
+ Local-first: **no Ordel LLM, no telemetry, no account, no data sent to Ordel.** The only
73
+ network requests are to your own target app and standard package/browser downloads you
74
+ initiate. See [PRIVACY.md](PRIVACY.md).
@@ -0,0 +1,8 @@
1
+ """Ordel free CLI — local QA-automation shell over the deterministic engine."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from ordel_cli.heal_service import CircuitOpenError, HealService
6
+ from ordel_cli.store import OrdelStore
7
+
8
+ __all__ = ["OrdelStore", "HealService", "CircuitOpenError"]
@@ -0,0 +1,26 @@
1
+ """Ordel attribution — the ◉◯ two-circle mark on key MCP responses.
2
+
3
+ When a coding agent relays Ordel's output, Ordel's work can get shadowed by the agent's
4
+ own voice. A small, consistent signature on the KEY tool responses (coverage, scenarios,
5
+ risk/plan/regression, explore, record, pom) keeps the attribution visible without being
6
+ noisy — one line appended to the ascii, and a `signature` field on the payload.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ from typing import Any
12
+
13
+ SIGNATURE = "◉◯ ordel"
14
+ _FOOTER = "\n " + SIGNATURE
15
+
16
+
17
+ def sign(result: dict[str, Any]) -> dict[str, Any]:
18
+ """Attach Ordel's signature to a tool result (idempotent): a `signature` field, and a
19
+ footer line on the `ascii` output when present. Mutates and returns the same dict."""
20
+ if not isinstance(result, dict):
21
+ return result
22
+ result.setdefault("signature", SIGNATURE)
23
+ ascii_out = result.get("ascii")
24
+ if isinstance(ascii_out, str) and SIGNATURE not in ascii_out:
25
+ result["ascii"] = ascii_out + _FOOTER
26
+ return result
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Ordel free-CLI page capture (one-shot).
3
+ *
4
+ * Navigates to a URL with the PROJECT's own Playwright (path passed via
5
+ * ORDEL_PW_PATH so require() resolves against the dev's node_modules, exactly
6
+ * like run_test uses the project's `npx playwright`) and extracts signals for
7
+ * the page's meaningful elements via the shared extractor. Emits a JSON document:
8
+ * { "url", "title", "elements": [ { "key", signals... }, ... ] }
9
+ * The Python side turns each element's signals into an ElementFingerprint. No LLM.
10
+ *
11
+ * This is the single-shot path (open→goto→capture→close). The persistent
12
+ * agent-driven path lives in session_driver.cjs and shares the same extractor.
13
+ *
14
+ * Usage: ORDEL_PW_PATH=/abs/@playwright/test node capture.cjs <url>
15
+ */
16
+ 'use strict';
17
+
18
+ const path = require('path');
19
+ const { extract } = require('./capture_extract.cjs');
20
+
21
+ const url = process.argv[2];
22
+ const pwPath = process.env.ORDEL_PW_PATH;
23
+ if (!url || !pwPath) {
24
+ console.error('usage: ORDEL_PW_PATH=<@playwright/test> node capture.cjs <url>');
25
+ process.exit(2);
26
+ }
27
+
28
+ (async () => {
29
+ // absolute so Node treats it as a path, not a node_modules package lookup
30
+ // eslint-disable-next-line
31
+ const { chromium } = require(path.resolve(pwPath));
32
+ const browser = await chromium.launch({ headless: process.env.ORDEL_HEADED !== '1' });
33
+ try {
34
+ const page = await browser.newPage();
35
+ const resp = await page.goto(url, { waitUntil: 'networkidle', timeout: 30000 });
36
+ const httpStatus = resp ? resp.status() : 0;
37
+ const title = await page.title();
38
+ const elements = await page.evaluate(extract);
39
+ process.stdout.write(JSON.stringify({ url: page.url(), title, elements, httpStatus }));
40
+ } finally {
41
+ await browser.close();
42
+ }
43
+ })().catch((e) => {
44
+ console.error(String((e && e.stack) || e));
45
+ process.exit(1);
46
+ });