@brokkai/slopcop 0.0.1 → 0.0.3

package/LICENSE

@@ -1,201 +1,201 @@
-                                 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 [yyyy] [name of copyright owner]
-
-   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.
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -1,218 +1,238 @@
-# SlopCop
-
-SlopCop checks a change through the yet to be deployed hosted SlopCop check
-API. The CLI ships the working-tree change to the service, the service applies
-it to the base commit and runs the hosted policy catalog plus any repository
-rules selected, and the CLI prints the report. There is no local analyzer: a check never needs a
-Bifrost install, and the CLI never decides on its own that there is nothing to
-check.
-
-The command is built for agents and one-shot CI: no prompts, one request, and
-the analyzer's exit contract.
-
-## Install
-
-```console
-make install
-```
-
-or:
-
-```console
-go install github.com/BrokkAi/slopcop/cmd/slopcop@latest
-```
-
-Go 1.25 or newer is required to build.
-
-On Windows, the PowerShell installer takes the latest release instead of
-building:
-
-```powershell
-irm https://raw.githubusercontent.com/BrokkAi/slopcop/master/install.ps1 | iex
-```
-
-It verifies the release checksum, installs `slopcop.exe` to
-`%LOCALAPPDATA%\Programs\slopcop`, and adds that directory to the user `Path`.
-`SLOPCOP_VERSION`, `SLOPCOP_INSTALL_DIR`, and `SLOPCOP_NO_MODIFY_PATH` override
-its defaults.
-
-The npm package carries the release binary for macOS, Linux, and Windows on x64
-and arm64, so it needs no Go toolchain:
-
-```console
-npm install --global @brokkai/slopcop
-npx @brokkai/slopcop --help
-```
-
-Node 22 or newer is required to run that package.
-
-## Enable it in an agent
-
-The binary carries the agent skill that teaches a coding agent how to run
-slopcop. `slopcop init` installs it into each well-known skills directory whose
-harness is present, and names what it did:
-
-| Location | Harness |
-| --- | --- |
-| `~/.agents/skills/slopcop/` | Codex, opencode |
-| `~/.claude/skills/slopcop/` | Claude Code, opencode |
-| `$CODEX_HOME/skills/slopcop/`, or `~/.codex/skills/slopcop/` | Codex home |
-
-A skill that is already there is left alone, so local edits survive and running
-init again is safe. `slopcop init --no-skill` skips the install and any update
-of it.
-
-## Sign in
-
-```console
-slopcop login                           # browser device flow
-slopcop login --token "$SLOPCOP_TOKEN"  # existing credential, for CI and agents
-```
-
-The browser flow prints a URL and a code and stores the token once the login is
-approved. The service URL defaults to `https://slopcop.com`; `--service`,
-`$SLOPCOP_SERVICE`, or a stored value override it.
-
-The credential lives in `slopcop/config.json` under the user config directory
-and is written owner-only. `slopcop logout` clears it.
-
-Precedence:
-
-| Value | Order |
-| --- | --- |
-| Service URL | `--service`, `$SLOPCOP_SERVICE`, stored by `slopcop login`, `https://slopcop.com` |
-| Token | `$SLOPCOP_TOKEN`, stored value |
-
-## Check
-
-```console
-slopcop                          # check the change in the current checkout
-slopcop check --format json      # same, machine-readable
-slopcop --root ../repo --base HEAD~1
-```
-
-The base commit defaults to the merge base with the branch upstream, then the
-merge base with `origin/HEAD`, then `HEAD`. The service must already have the
-base commit in its clone; a missing one comes back as the service's
-`base_not_found` message and remedy.
-
-Every run sends one check request, even when the working tree matches the base
-and the patch is empty. A clean result or a failure always comes from the
-service.
-
-Flags:
-
-| Flag | Meaning |
-| --- | --- |
-| `--root PATH` | repository to check (default `.`) |
-| `--base REV` | base commit or revision for the change |
-| `--format human\|json\|sarif` | report format (default `human`) |
-| `--fail-on never\|finding\|note\|warning\|error` | exit-1 threshold (default `finding`) |
-| `--policy PATH` | repository-relative `.rqlp` file to evaluate (repeatable) |
-| `--no-policy-discovery` | skip `.slopcop/policies` rules |
-| `--timeout DURATION` | one check request timeout (default `10m`) |
-| `--verbose` | print the resolved request to stderr |
-
-### What is sent
-
-One git patch from the base commit to the working tree. An empty change is
-sent as an empty patch, not filtered out. The patch carries committed but
-unpushed work, unstaged edits, untracked files, deletions, renames, mode
-changes, and binary content. Git-ignored files stay out, except selected
-`.slopcop/policies` rules, which must travel because the service evaluates them
-from the patched checkout.
-
-The service owns the limits on what a check accepts. When a change is too
-large or touches too many files, the service's `payload_too_large` response is
-printed verbatim; the CLI does not impose its own limits.
-
-Every check also runs the hosted catalog. Rules under
-`.slopcop/policies/**/*.rqlp` are added automatically unless
-`--no-policy-discovery` is set.
-
-### Output and exit codes
-
-The service answers structured data; the CLI renders it. `human` prints one
-block per finding, a summary line, and any omitted or incomplete checks. `json`
-prints `status`, `baseCommit`, `summary`, `findings`, `incomplete`, and
-`failure` when the analysis did not complete. `sarif` prints a SARIF 2.1.0
-log.
-
-| Exit | Meaning |
-| --- | --- |
-| `0` | Check completed; nothing crossed the `--fail-on` level |
-| `1` | A finding crossed `--fail-on` |
-| `2` | The check was incomplete, or the CLI or service failed |
-
-The service applies `--fail-on` and sets the status; the exit code follows it.
-
-Service failures print the closed contract exactly: message, remedy, and any
-install URL. The codes, messages, and remedies are defined by the service in
-`server/src/check.rs` of `BrokkAi/bifrost-service`; the CLI does not
-rewrite them. The remedies name no client, so when one says to sign in the CLI
-adds the `slopcop login` command after it. A failed request prints no report
-on stdout.
-
-While SlopCop is still indexing the repository, the service answers
-`indexing_in_progress` at once instead of running the check. The CLI prints it
-and exits `2` without waiting or retrying.
-
-## API
-
-The CLI calls `POST <service>/v1/check` with a bearer token:
-
-```json
-{
-  "repoUrl": "https://github.com/owner/name",
-  "baseCommit": "0123456789abcdef0123456789abcdef01234567",
-  "change": "<base64 git patch>",
-  "selection": {"files": [".slopcop/policies/rule.rqlp"]},
-  "failOn": "finding"
-}
-```
-
-The service rejects any other field. The response carries `status`,
-`baseCommit`, `applied`, `summary`, `findings`, `incomplete`, and `failure`
-when the analysis did not complete. Non-2xx responses carry `code`, `message`,
-`remedy`, `retryable`, and an optional `installUrl`.
-
-`slopcop login` uses the device flow: `POST /api/device` returns a
-`deviceCode`, `userCode`, `verificationUri`, `expiresIn`, and `interval`, and
-`POST /api/token` returns `202` while pending or `200` with a `token` once
-approved. The polling codes are `authorization_pending`, `slow_down`,
-`expired_token`, and `access_denied`.
-
-## Development
-
-```console
-make test        # go test ./...
-make vet         # go vet ./...
-make build       # bin/slopcop-<goos>-<goarch>
-make cross-check # linux, darwin, and windows on amd64 and arm64
-make npm-test    # node --test npm/test
-```
-
-Releases are tag-driven. Pushing a `v*.*.*` tag runs GoReleaser, which builds
-linux, darwin, and windows for amd64 and arm64, packages `tar.gz` archives
-(`zip` on Windows) with `checksums.txt`, and publishes the GitHub release.
-`.goreleaser.yaml` is the single source of truth; CI runs `goreleaser check`
-and a snapshot build on every change, and `make release-check` runs the same
-locally when GoReleaser is installed. The same tag push then packs
-`@brokkai/slopcop` from those release archives and publishes it to npm with
-[trusted publishing](docs/npm-publishing.md), so the package needs no npm
-token.
-
-Layout:
-
-| Path | Purpose |
-| --- | --- |
-| `cmd/slopcop` | process entry point |
-| `internal/cli` | cobra commands, selection, exit codes |
-| `internal/gitx` | remote canonicalization, base resolution, patch building |
-| `internal/service` | `/v1/check` client and the wire contract |
-| `internal/report` | human, JSON, and SARIF rendering from the structured response |
-| `internal/config` | stored service URL and token |
-| `npm` | launcher, packer, and tests of the `@brokkai/slopcop` package |
-| `skills/slopcop` | the agent skill the binary embeds and installs |
-| `docs/npm-publishing.md` | npm release flow and trusted publisher setup |
-| `.goreleaser.yaml` | tag release build, archives, and checksums |
+# SlopCop
+
+SlopCop checks a change through the yet to be deployed hosted SlopCop check
+API. The CLI ships the working-tree change to the service, the service applies
+it to the base commit and runs the hosted policy catalog plus any repository
+rules selected, and the CLI prints the report. There is no local analyzer: a check never needs a
+Bifrost install, and the CLI never decides on its own that there is nothing to
+check.
+
+The command is built for agents and one-shot CI: no prompts, one request, and
+the analyzer's exit contract.
+
+## Install
+
+```console
+make install
+```
+
+or:
+
+```console
+go install github.com/BrokkAi/slopcop/cmd/slopcop@latest
+```
+
+Go 1.25 or newer is required to build.
+
+On Windows, the PowerShell installer takes the latest release instead of
+building:
+
+```powershell
+irm https://raw.githubusercontent.com/BrokkAi/slopcop/master/install.ps1 | iex
+```
+
+It verifies the release checksum, installs `slopcop.exe` to
+`%LOCALAPPDATA%\Programs\slopcop`, and adds that directory to the user `Path`.
+`SLOPCOP_VERSION`, `SLOPCOP_INSTALL_DIR`, and `SLOPCOP_NO_MODIFY_PATH` override
+its defaults.
+
+The npm package carries the release binary for macOS, Linux, and Windows on x64
+and arm64, so it needs no Go toolchain:
+
+```console
+npm install --global @brokkai/slopcop
+npx @brokkai/slopcop --help
+```
+
+Node 22 or newer is required to run that package.
+
+The PyPI package carries the release binary for those same targets as wheels,
+so it needs no Go toolchain either:
+
+```console
+pip install brokk-slopcop
+```
+
+The package is `brokk-slopcop` because PyPI already has an unrelated project
+named `slopcop`; the command it installs is still `slopcop`, and `python -m
+brokk_slopcop` runs the same binary.
+
+## Enable it in an agent
+
+The binary carries the agent skill that teaches a coding agent how to run
+slopcop. `slopcop init` installs it into each well-known skills directory whose
+harness is present, and names what it did:
+
+| Location | Harness |
+| --- | --- |
+| `~/.agents/skills/slopcop/` | Codex, opencode |
+| `~/.claude/skills/slopcop/` | Claude Code, opencode |
+| `$CODEX_HOME/skills/slopcop/`, or `~/.codex/skills/slopcop/` | Codex home |
+
+A skill that is already there is left alone, so local edits survive and running
+init again is safe. `slopcop init --no-skill` skips the install and any update
+of it.
+
+## Sign in
+
+```console
+slopcop login                           # browser device flow
+slopcop login --token "$SLOPCOP_TOKEN"  # existing credential, for CI and agents
+```
+
+The browser flow prints a URL and a code and stores the token once the login is
+approved. The service URL defaults to `https://slopcop.com`; `--service`,
+`$SLOPCOP_SERVICE`, or a stored value override it.
+
+The credential lives in `slopcop/config.json` under the user config directory
+and is written owner-only. `slopcop logout` clears it.
+
+Precedence:
+
+| Value | Order |
+| --- | --- |
+| Service URL | `--service`, `$SLOPCOP_SERVICE`, stored by `slopcop login`, `https://slopcop.com` |
+| Token | `$SLOPCOP_TOKEN`, stored value |
+
+## Check
+
+```console
+slopcop                          # check the change in the current checkout
+slopcop check --format json      # same, machine-readable
+slopcop --root ../repo --base HEAD~1
+```
+
+The base commit defaults to the merge base with the branch upstream, then the
+merge base with `origin/HEAD`, then `HEAD`. The service must already have the
+base commit in its clone; a missing one comes back as the service's
+`base_not_found` message and remedy.
+
+Every run sends one check request, even when the working tree matches the base
+and the patch is empty. A clean result or a failure always comes from the
+service.
+
+Flags:
+
+| Flag | Meaning |
+| --- | --- |
+| `--root PATH` | repository to check (default `.`) |
+| `--base REV` | base commit or revision for the change |
+| `--format human\|json\|sarif` | report format (default `human`) |
+| `--fail-on never\|finding\|note\|warning\|error` | exit-1 threshold (default `finding`) |
+| `--policy PATH` | repository-relative `.rqlp` file to evaluate (repeatable) |
+| `--no-policy-discovery` | skip `.slopcop/policies` rules |
+| `--timeout DURATION` | one check request timeout (default `10m`) |
+| `--verbose` | print the resolved request to stderr |
+
+### What is sent
+
+One git patch from the base commit to the working tree. An empty change is
+sent as an empty patch, not filtered out. The patch carries committed but
+unpushed work, unstaged edits, untracked files, deletions, renames, mode
+changes, and binary content. Git-ignored files stay out, except selected
+`.slopcop/policies` rules, which must travel because the service evaluates them
+from the patched checkout.
+
+The service owns the limits on what a check accepts. When a change is too
+large or touches too many files, the service's `payload_too_large` response is
+printed verbatim; the CLI does not impose its own limits.
+
+Every check also runs the hosted catalog. Rules under
+`.slopcop/policies/**/*.rqlp` are added automatically unless
+`--no-policy-discovery` is set.
+
+### Output and exit codes
+
+The service answers structured data; the CLI renders it. `human` prints one
+block per finding, a summary line, and any omitted or incomplete checks. `json`
+prints `status`, `baseCommit`, `summary`, `findings`, `incomplete`, and
+`failure` when the analysis did not complete. `sarif` prints a SARIF 2.1.0
+log.
+
+| Exit | Meaning |
+| --- | --- |
+| `0` | Check completed; nothing crossed the `--fail-on` level |
+| `1` | A finding crossed `--fail-on` |
+| `2` | The check was incomplete, or the CLI or service failed |
+
+The service applies `--fail-on` and sets the status; the exit code follows it.
+
+Service failures print the closed contract exactly: message, remedy, and any
+install URL. The codes, messages, and remedies are defined by the service in
+`server/src/check.rs` of `BrokkAi/bifrost-service`; the CLI does not
+rewrite them. The remedies name no client, so when one says to sign in the CLI
+adds the `slopcop login` command after it. A failed request prints no report
+on stdout.
+
+While SlopCop is still indexing the repository, the service answers
+`indexing_in_progress` at once instead of running the check. The CLI prints it
+and exits `2` without waiting or retrying.
+
+## API
+
+The CLI calls `POST <service>/v1/check` with a bearer token:
+
+```json
+{
+  "repoUrl": "https://github.com/owner/name",
+  "baseCommit": "0123456789abcdef0123456789abcdef01234567",
+  "change": "<base64 git patch>",
+  "selection": {"files": [".slopcop/policies/rule.rqlp"]},
+  "failOn": "finding"
+}
+```
+
+The service rejects any other field. The response carries `status`,
+`baseCommit`, `applied`, `summary`, `findings`, `incomplete`, and `failure`
+when the analysis did not complete. Non-2xx responses carry `code`, `message`,
+`remedy`, `retryable`, and an optional `installUrl`.
+
+`slopcop login` uses the device flow: `POST /api/device` returns a
+`deviceCode`, `userCode`, `verificationUri`, `expiresIn`, and `interval`, and
+`POST /api/token` returns `202` while pending or `200` with a `token` once
+approved. The polling codes are `authorization_pending`, `slow_down`,
+`expired_token`, and `access_denied`.
+
+## Development
+
+```console
+make test        # go test ./...
+make vet         # go vet ./...
+make build       # bin/slopcop-<goos>-<goarch>
+make cross-check # linux, darwin, and windows on amd64 and arm64
+make npm-test    # node --test npm/test
+make wheels      # pypi-dist/, one wheel per release target
+```
+
+Releases are tag-driven. Pushing a `v*.*.*` tag runs GoReleaser, which builds
+linux, darwin, and windows for amd64 and arm64, packages `tar.gz` archives
+(`zip` on Windows) with `checksums.txt`, and publishes the GitHub release.
+`.goreleaser.yaml` is the single source of truth; CI runs `goreleaser check`
+and a snapshot build on every change, and `make release-check` runs the same
+locally when GoReleaser is installed. The same tag push then packs
+`@brokkai/slopcop` from those release archives and publishes it to npm with
+[trusted publishing](docs/npm-publishing.md), so the package needs no npm
+token.
+
+The same tag also packs a wheel per release target from the binaries GoReleaser
+just built, installs the wheel for every platform GitHub can run, and
+publishes `brokk-slopcop` to PyPI with
+[trusted publishing](docs/pypi-publishing.md), so that package needs no PyPI
+token either.
+
+Layout:
+
+| Path | Purpose |
+| --- | --- |
+| `cmd/slopcop` | process entry point |
+| `internal/cli` | cobra commands, selection, exit codes |
+| `internal/gitx` | remote canonicalization, base resolution, patch building |
+| `internal/service` | `/v1/check` client and the wire contract |
+| `internal/report` | human, JSON, and SARIF rendering from the structured response |
+| `internal/config` | stored service URL and token |
+| `npm` | launcher, packer, and tests of the `@brokkai/slopcop` package |
+| `packaging/pypi` | wheel packer and launcher of the `brokk-slopcop` package |
+| `skills/slopcop` | the agent skill the binary embeds and installs |
+| `docs/npm-publishing.md` | npm release flow and trusted publisher setup |
+| `docs/pypi-publishing.md` | PyPI release flow and trusted publisher setup |
+| `.goreleaser.yaml` | tag release build, archives, and checksums |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brokkai/slopcop",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Check a change through the hosted SlopCop check API",
   "license": "Apache-2.0",
   "repository": {