lurqrun 0.1.0 → 0.1.1

package/LICENSE

@@ -1,201 +1,21 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-"License" shall mean the terms and conditions for use, reproduction,
-and distribution as defined by Sections 1 through 9 of this document.
-
-"Licensor" shall mean the copyright owner or entity authorized by
-the copyright owner that is granting the License.
-
-"Legal Entity" shall mean the union of the acting entity and all
-other entities that control, are controlled by, or are under common
-control with that entity. For the purposes of this definition,
-"control" means (i) the power, direct or indirect, to cause the
-direction or management of such entity, whether by contract or
-otherwise, or (ii) ownership of fifty percent (50%) or more of the
-outstanding shares, or (iii) beneficial ownership of such entity.
-
-"You" (or "Your") shall mean an individual or Legal Entity
-exercising permissions granted by this License.
-
-"Source" form shall mean the preferred form for making modifications,
-including but not limited to software source code, documentation
-source, and configuration files.
-
-"Object" form shall mean any form resulting from mechanical
-transformation or translation of a Source form, including but
-not limited to compiled object code, generated documentation,
-and conversions to other media types.
-
-"Work" shall mean the work of authorship, whether in Source or
-Object form, made available under the License, as indicated by a
-copyright notice that is included in or attached to the work
-(an example is provided in the Appendix below).
-
-"Derivative Works" shall mean any work, whether in Source or Object
-form, that is based on (or derived from) the Work and for which the
-editorial revisions, annotations, elaborations, or other modifications
-represent, as a whole, an original work of authorship. For the purposes
-of this License, Derivative Works shall not include works that remain
-separable from, or merely link (or bind by name) to the interfaces of,
-the Work and Derivative Works thereof.
-
-"Contribution" shall mean any work of authorship, including
-the original version of the Work and any modifications or additions
-to that Work or Derivative Works thereof, that is intentionally
-submitted to Licensor for inclusion in the Work by the copyright owner
-or by an individual or Legal Entity authorized to submit on behalf of
-the copyright owner. For the purposes of this definition, "submitted"
-means any form of electronic, verbal, or written communication sent
-to the Licensor or its representatives, including but not limited to
-communication on electronic mailing lists, source code control systems,
-and issue tracking systems that are managed by, or on behalf of, the
-Licensor for the purpose of discussing and improving the Work, but
-excluding communication that is conspicuously marked or otherwise
-designated in writing by the copyright owner as "Not a Contribution."
-
-"Contributor" shall mean Licensor and any individual or Legal Entity
-on behalf of whom a Contribution has been received by Licensor and
-subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-this License, each Contributor hereby grants to You a perpetual,
-worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-copyright license to reproduce, prepare Derivative Works of,
-publicly display, publicly perform, sublicense, and distribute the
-Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-this License, each Contributor hereby grants to You a perpetual,
-worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-(except as stated in this section) patent license to make, have made,
-use, offer to sell, sell, import, and otherwise transfer the Work,
-where such license applies only to those patent claims licensable
-by such Contributor that are necessarily infringed by their
-Contribution(s) alone or by combination of their Contribution(s)
-with the Work to which such Contribution(s) was submitted. If You
-institute patent litigation against any entity (including a
-cross-claim or counterclaim in a lawsuit) alleging that the Work
-or a Contribution incorporated within the Work constitutes direct
-or contributory patent infringement, then any patent licenses
-granted to You under this License for that Work shall terminate
-as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-Work or Derivative Works thereof in any medium, with or without
-modifications, and in Source or Object form, provided that You
-meet the following conditions:
-
-(a) You must give any other recipients of the Work or
-Derivative Works a copy of this License; and
-
-(b) You must cause any modified files to carry prominent notices
-stating that You changed the files; and
-
-(c) You must retain, in the Source form of any Derivative Works
-that You distribute, all copyright, patent, trademark, and
-attribution notices from the Source form of the Work,
-excluding those notices that do not pertain to any part of
-the Derivative Works; and
-
-(d) If the Work includes a "NOTICE" text file as part of its
-distribution, then any Derivative Works that You distribute must
-include a readable copy of the attribution notices contained
-within such NOTICE file, excluding those notices that do not
-pertain to any part of the Derivative Works, in at least one
-of the following places: within a NOTICE text file distributed
-as part of the Derivative Works; within the Source form or
-documentation, if provided along with the Derivative Works; or,
-within a display generated by the Derivative Works, if and
-wherever such third-party notices normally appear. The contents
-of the NOTICE file are for informational purposes only and
-do not modify the License. You may add Your own attribution
-notices within Derivative Works that You distribute, alongside
-or as an addendum to the NOTICE text from the Work, provided
-that such additional attribution notices cannot be construed
-as modifying the License.
-
-You may add Your own copyright statement to Your modifications and
-may provide additional or different license terms and conditions
-for use, reproduction, or distribution of Your modifications, or
-for any such Derivative Works as a whole, provided Your use,
-reproduction, and distribution of the Work otherwise complies with
-the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-any Contribution intentionally submitted for inclusion in the Work
-by You to the Licensor shall be under the terms and conditions of
-this License, without any additional terms or conditions.
-Notwithstanding the above, nothing herein shall supersede or modify
-the terms of any separate license agreement you may have executed
-with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-names, trademarks, service marks, or product names of the Licensor,
-except as required for reasonable and customary use in describing the
-origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-agreed to in writing, Licensor provides the Work (and each
-Contributor provides its Contributions) on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-implied, including, without limitation, any warranties or conditions
-of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-PARTICULAR PURPOSE. You are solely responsible for determining the
-appropriateness of using or redistributing the Work and assume any
-risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-whether in tort (including negligence), contract, or otherwise,
-unless required by applicable law (such as deliberate and grossly
-negligent acts) or agreed to in writing, shall any Contributor be
-liable to You for damages, including any direct, indirect, special,
-incidental, or consequential damages of any character arising as a
-result of this License or out of the use or inability to use the
-Work (including but not limited to damages for loss of goodwill,
-work stoppage, computer failure or malfunction, or any and all
-other commercial damages or losses), even if such Contributor
-has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-the Work or Derivative Works thereof, You may choose to offer,
-and charge a fee for, acceptance of support, warranty, indemnity,
-or other liability obligations and/or rights consistent with this
-License. However, in accepting such obligations, You may act only
-on Your own behalf and on Your sole responsibility, not on behalf
-of any other Contributor, and only if You agree to indemnify,
-defend, and hold each Contributor harmless for any liability
-incurred by, or claims asserted against, such Contributor by reason
-of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-To apply the Apache License to your work, attach the following
-boilerplate notice, with the fields enclosed by brackets "{}"
-replaced with your own identifying information. (Don't include
-the brackets!)  The text should be enclosed in the appropriate
-comment syntax for the file format. We also recommend that a
-file or class name and description of purpose be included on the
-same "printed page" as the copyright notice for easier
-identification within third-party archives.
-
-Copyright 2026 Jaden Ryu
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+MIT License
+
+Copyright (c) 2026 Jaden Ryu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,15 +2,14 @@
 
 # lurq
 
-**Execution-verified dependency intelligence for AI coding agents.**
+**The verification layer for AI coding agents to ship unbreakable code.**
 
-A live index of npm scored from public signals, plus a sandbox that settles the
-questions metadata can't — exposed as an MCP server, a CLI, an HTTP API, and an
-installable agent skill.
+A live index of npm scored from public signals and co-installation through a sandbox. Use lurq
+through an MCP server, CLI, HTTP API, or an installable agent skill.
 
 [![npm version](https://img.shields.io/npm/v/lurqrun?color=%230b7285&label=npm)](https://www.npmjs.com/package/lurqrun)
 [![npm downloads](https://img.shields.io/npm/dm/lurqrun?color=%230b7285)](https://www.npmjs.com/package/lurqrun)
-[![license](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+[![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
 [![node](https://img.shields.io/badge/node-%3E%3D20-339933?logo=node.js&logoColor=white)](https://nodejs.org)
 [![MCP](https://img.shields.io/badge/MCP-compatible-6E56CF)](https://modelcontextprotocol.io)
 
@@ -22,21 +21,13 @@ installable agent skill.
 
 ## Why
 
-Your agent picks the dependencies now, and it picks them from training data frozen
-at its cutoff, ranked by how often a name appeared in text — not by whether the
-package is healthy today. So agents install libraries that are abandoned, carry
-open advisories, or don't exist at all.
+Your agent is terrible at resolving dependency matrices and maintaining old projects, leading to stack version drift. 
 
-lurq is what the agent checks first.
+lurq reads the shipped code instead and caches it so we can diff surfaces across versions. lurq upgrades stacks and reports failures before they can even happen. lurq is what the agent checks first when planning, updating, or deploying any project.
 
-Most of what matters is readable — release cadence, advisories, deprecations,
-types/tests/docs, bundle cost — and lurq ingests all of it daily. The rest isn't
-readable at all. Whether a package installs cleanly, whether it imports without
-throwing, whether two versions can coexist in one tree: those are only knowable by
-running them, so lurq runs them in an isolated sandbox and keeps the result.
-
-lurq recommends and explains packages; your agent writes the code. Responses are
-compact and token-budgeted, built for a context window rather than a screen.
+lurq's information comes from readable and executable sources. These include analyzing advisories, release cadence, deprecations, and sandboxing. Compatibility edges are
+minted continuously and stored in a Postgres database. Responses are
+compact and token-budgeted so lurq works alongside your agent. 
 
 > **Scope:** the JavaScript/TypeScript web stack (npm) only.
 
@@ -44,16 +35,15 @@ compact and token-budgeted, built for a context window rather than a screen.
 
 ## Quick start
 
-lurq is a **hosted service** — you don't run a database or a sync.
-[Create a free account](https://lurq.run/sign-up) to generate an API key, then run
-the guided installer:
+lurq is a **hosted service** — you don't run a database or a sync. One command,
+with nothing installed first:
 
 ```bash
-npx lurqrun install
+npx lurqrun
 ```
 
-It prompts for your key, validates it, detects your installed assistants, and
-writes a keyed remote MCP entry:
+This command runs the guided setup, allowing you to sign in and validate your system with an API key. lurq automatically 
+detects your installed assistants and writes a remote MCP entry.
 
 ```json
 {
@@ -65,6 +55,16 @@ writes a keyed remote MCP entry:
 
 **No database credentials ever touch your machine.** Restart your agent afterward.
 
+### The `lurq` command
+
+The package is published as **`lurqrun`**. The command you type is `lurq`, and it exists only once the package is
+installed.
+
+```bash
+npm install -g lurqrun     # then `lurq` works in any terminal
+lurq --version
+```
+
 <details>
 <summary><b>Supported assistants</b></summary>
 
@@ -76,12 +76,48 @@ self-host against your own database with `--local`.
 
 </details>
 
+<details>
+<summary><b>Uninstall, or start over</b></summary>
+
+**Reinstall** is just setup again. It is safe to re-run and overwrites previous runs.
+
+```bash
+npx lurqrun
+```
+
+**Uninstall** is three separate things, because setup writes to three places:
+
+```bash
+lurq logout                # forget the API key (~/.lurq/config.json)
+npm uninstall -g lurqrun   # remove the `lurq` command
+```
+
+The third is the MCP entries in your agents' config files. Delete the `lurq` entry from whichever of these you
+use:
+
+| Assistant | MCP config | Instructions file |
+|---|---|---|
+| Claude Code | `~/.claude.json` | `~/.claude/skills/lurq/SKILL.md` |
+| Cursor | `~/.cursor/mcp.json` | |
+| Windsurf | `~/.codeium/windsurf/mcp_config.json` | `~/.codeium/windsurf/memories/global_rules.md` |
+| VS Code / Copilot | `<VS Code user dir>/mcp.json` | |
+| Codex | `~/.codex/config.toml` | `~/.codex/AGENTS.md` |
+| Gemini CLI | `~/.gemini/settings.json` | `~/.gemini/GEMINI.md` |
+| Antigravity | `~/.gemini/config/mcp_config.json` | `~/.gemini/GEMINI.md` |
+| Kiro | `~/.kiro/settings/mcp.json` | `~/.kiro/steering/lurq.md` |
+
+`lurq logout` **only** clears the key stored for the CLI. A copy of it
+lives in each MCP entry above, so revoke the key from
+[the dashboard](https://lurq.run/dashboard/keys).
+
+</details>
+
 ---
 
 ## MCP tools
 
-Once installed, your agent can call these over MCP. Every response is compact and
-carries a `dataAsOf` timestamp.
+lurq can call these tools over MCP. Every response
+carries a `dataAsOf` timestamp so your agents know how fresh the information is. 
 
 | Tool | What it answers |
 |---|---|
@@ -97,8 +133,7 @@ carries a `dataAsOf` timestamp.
 | `diff_surface` | What a version bump adds, removes, renames, or changes arity on |
 | `report_outcome` | What happened after a pick shipped — installed clean, broke the build, resolved the task |
 
-`usage` is the one worth calling out: pass the version your model *thinks* it knows
-and get the precise delta to the version you're actually installing. That fact
+`usage` outputs the delta between your agent's analysis of a package versus lurq's ground truth. That fact
 exists in no changelog and no model's training data.
 
 ---
@@ -126,13 +161,20 @@ lurq plan ./project.md                     # a description in, a scored stack ou
 lurq upgrade-plan .                        # what's behind, and what each upgrade removes
 lurq check-upgrade . --plan lurq-plan.json --exit-code
 
+# Shipping your own (the same diff, pointed the other way)
+lurq check-release                         # is the version you're about to publish honest?
+lurq check-api --against origin/main       # does this break the callers of your API?
+
+# Finding your way around
+lurq can "will this upgrade break my code" # which lurq capability answers this?
+
 # Configuration & serving
 lurq weights                               # the exact ranking weights, printed
 lurq edit-weights --set composite.lambda=0.5
 lurq serve-http                            # run it as a rate-limited service of your own
 ```
 
-Every read command takes `--json`.
+Use the '-- json ' flag for every read command.
 
 ---
 
@@ -141,13 +183,8 @@ Every read command takes `--json`.
 lurq also keeps a repository's dependencies current **and rewrites the code an
 upgrade breaks.**
 
-Renovate and Dependabot open a PR that says *"bumped react-router 6→8"* and gate it
-on your test suite. If coverage misses the affected path, the PR merges green and
-breaks in production.
-
-lurq opens a PR that says *"bumped react-router 6→8, and rewrote the 14 call sites
-that used `useHistory`, which no longer exists"* — because it holds the
-symbol-level surface diff and intersects it with what your code references.
+lurq can open PRs addressing the symbol-level API surface diff 
+and resolve with what calls your code references.
 
 **The gate needs no tests at all.**
 
@@ -168,20 +205,19 @@ unverified could not be established            → never counted as safe
 | 4. `create-pull-request` — one branch, one PR | your runner | `GITHUB_TOKEN` |
 | 5. Outcomes post back — names and counts, never source | lurq | — |
 
-Steps 1–2 are the default. The generated workflow starts in `comment` mode: it
-plans, checks, and writes the brief to the run summary, changing nothing. Editing
-is opt-in per repository.
+Steps 1–2 are the default and are also available on the web app through project autopilot. The generated workflow starts in `comment` mode: it
+plans, checks, and writes the brief to the run summary. Editing
+is opt-in per repository. Click the policy tab to set global security parameters. 
 
 ### Trust model
 
 - **lurq's GitHub App is `Contents: read-only` and stays that way.** It cannot
   write to any repository, ever.
 - **Every write uses your own `GITHUB_TOKEN`** — ephemeral, scoped to one repo,
-  limited to what the `permissions:` block in a file *you* committed declares.
+  limited to the `permissions:` block in your committed file.
 - **The agent cannot touch version control.** Its allowlist is
-  `Read,Edit,Write,Bash(<pkg-manager>:*)` — no `git`, no network. The model edits
-  files; the *workflow* commits. A prompt injection in a dependency's changelog
-  cannot push a branch.
+  `Read,Edit,Write,Bash(<pkg-manager>:*)`. Your agent can only edit
+  files. 
 - **Revoking it is `git rm .github/workflows/lurq-upgrade.yml`.**
 
 Architecture and limits: [`docs/lurq-autopilot.md`](docs/lurq-autopilot.md).
@@ -190,28 +226,22 @@ Architecture and limits: [`docs/lurq-autopilot.md`](docs/lurq-autopilot.md).
 
 ## Where the evidence comes from
 
-Two sources, and the distinction is the whole point.
-
 **Readable** — npm, GitHub, deps.dev, and OSV, re-synced daily. Downloads, release
-cadence, maintenance, advisories, deprecations, license, bundle cost. This is what
-scoring runs on.
+cadence, maintenance, advisories, deprecations, license, bundle cost. 
 
 **Executed** — an isolated sandbox (E2B, with a local driver for trusted work) that
-installs a package version, imports it, and records what happened. Co-installing a
-set is how compatibility is established: a successful co-install is positive proof
-two versions coexist, a failure is proof they conflict, and the error is kept as
-evidence. `compat` and `plan` read those edges, which is why lurq can tell you a
-*stack* holds together rather than only that each package looks fine alone.
+installs and imports a package version. Results are recorded in the compatibility matrix.
+Compatibility is established through co-installation. `compat` and `plan` read those edges, which is why lurq can tell you 
+that an entire stack holds together.
 
-Facts of the second kind appear in no changelog and no model's training data, and
-they go stale unless someone keeps re-running the experiment.
+Executable proof allows lurq to look beyond changelogs and training data.
 
 ---
 
 ## How ranking works
 
 Deterministic, and public. **No model sits in the ranking path** — `recommend` is
-hybrid vector + full-text search over precomputed scores, which is why it's fast,
+hybrid vector + full-text search over precomputed scores, which is why lurq is fast,
 cheap, and reproducible.
 
 ```
@@ -220,19 +250,17 @@ quality = types · tests · docs · changelog · dep count · license · provena
 composite = blend at a single tunable λ (default 0.35)
 ```
 
-`quality` is a separate, **adoption-independent** axis, so a well-built new package
-isn't buried by an old popular one.
+`quality` is a separate, **adoption-independent** axis.
 
 Every weight lives in [`src/scoring/weights.ts`](src/scoring/weights.ts) and is
-printable with `lurq weights`. An answer an agent acts on is worth nothing if it
-can't be audited.
+printable with `lurq weights`.
 
 ---
 
 ## Contact
 
-Inquiries, partnerships, or proposals: **jadenryu@gmail.com**
+Inquiries, partnerships, or proposals: **jadenryu@lurq.run**
 
 ## License
 
-[Apache-2.0](LICENSE)
+[MIT](LICENSE)