brasscoders 2.0.4__tar.gz

brasscoders-2.0.4/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

brasscoders-2.0.4/NOTICE

@@ -0,0 +1,5 @@
+brass-ai-coders
+Copyright 2026 Copper Sun Content and Creative, LLC
+
+This product includes software developed by Copper Sun Content and
+Creative, LLC (https://coppersun.dev/).

brasscoders-2.0.4/PKG-INFO

@@ -0,0 +1,251 @@
+Metadata-Version: 2.4
+Name: brasscoders
+Version: 2.0.4
+Summary: BrassCoders for AI Coders — noise filter for AI-generated code
+Author-email: Copper Sun Brass Team <info@coppersun.dev>
+License: Apache-2.0
+Project-URL: Homepage, https://coppersun.dev/
+Project-URL: Issues, https://github.com/CopperSunDev/brass-intelligence/issues
+Keywords: claude-code,ai-coding,code-review,noise-filter,static-analysis
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: PyYAML<7,>=6.0
+Requires-Dist: requests<3,>=2.32
+Requires-Dist: bandit<2,>=1.8
+Requires-Dist: pylint<4,>=3.3
+Requires-Dist: radon<7,>=6.0
+Requires-Dist: vulture<3,>=2.0
+Requires-Dist: detect-secrets<2,>=1.5
+Requires-Dist: pyre-check<0.10,>=0.9.25
+Requires-Dist: py-spy<1,>=0.3
+Provides-Extra: dev
+Requires-Dist: pytest<9,>=7.0; extra == "dev"
+Requires-Dist: pytest-cov<7,>=4.0; extra == "dev"
+Requires-Dist: pytest-timeout<3,>=2.0; extra == "dev"
+Requires-Dist: pytest-xdist<4,>=3.0; extra == "dev"
+Provides-Extra: performance
+Requires-Dist: pyperf<3,>=2.0; extra == "performance"
+Dynamic: license-file
+
+# BrassCoders — noise filter for AI-generated code
+
+BrassCoders scans a codebase and produces a small set of structured intelligence files
+(`.brass/*.yaml`) designed to be read by Claude Code, Cursor, or any other AI
+coding assistant. The goal is to surface what matters — real security risks,
+PII leaks, performance pitfalls — and hide what doesn't, so the AI's review
+stops drowning useful signal in low-confidence noise.
+
+BrassCoders is a one-shot CLI: it scans, writes the YAML, and exits. There is no
+background daemon, no telemetry by default, and no outbound network calls
+unless you opt in.
+
+## What it produces
+
+After `brasscoders scan`, you'll find these files in `.brass/`:
+
+| File | Purpose |
+|---|---|
+| `ai_instructions.yaml` | Top-level summary an AI should read first |
+| `detailed_analysis.yaml` | Every finding, grouped by type |
+| `file_intelligence.yaml` | Findings collated per file, ranked by priority |
+| `security_report.yaml` | Security-only view (secrets, injection, auth issues) |
+| `statistics.yaml` | Aggregate counts and severity distribution |
+| `privacy_analysis.yaml` | Privacy-only view (only when PII findings exist) |
+
+Output directory permissions are `0700`; individual files are `0600`. BrassCoders
+scans private source code, so this is enforced rather than opt-in.
+
+## What it detects
+
+| Category | Source |
+|---|---|
+| Secrets (AWS, Azure, GitHub, GitLab, Slack, Stripe, NPM, PEM, JWT, …) | [`detect-secrets`](https://github.com/Yelp/detect-secrets) |
+| Code-quality issues (complexity, dead code, common bugs) | Bandit + Pylint + Radon + AST patterns |
+| PII (credit card, SSN, IBAN, NHS, NINO, Aadhaar, PAN, NRIC, Medicare, TFN) | Pattern + Luhn-validated regex |
+| AI-coder anti-patterns (string concat in loops, insert-at-zero, nested loops, eval-on-input) | BrassCoders-specific AST analysis |
+| Authentication anti-patterns (hardcoded secrets, weak JWT, no rate limit) | BrassCoders-specific regex |
+
+Findings are de-duplicated and noise-filtered before they hit disk.
+
+## Supported languages
+
+BrassCoders is **Python-first**. The scanners that drive deepest analysis — Pysa
+(interprocedural taint), Bandit, Pylint, and the BrassCoders-specific AI-coder
+anti-pattern detectors — are Python-only.
+
+| Language | Coverage | Notes |
+|---|---|---|
+| Python | Full | Interprocedural taint, security, quality, anti-patterns |
+| JavaScript / TypeScript | Pattern-level | Intraprocedural Semgrep OSS rules; no interprocedural taint |
+| Other | Best-effort | Secrets detection and generic patterns where applicable |
+
+For JS-heavy applications that need deep taint analysis, BrassCoders should
+be paired with a JS-specific SAST (CodeQL, etc.). The BrassCoders team is
+tracking JS taint quality as a known pre-launch limitation.
+
+## Install
+
+```bash
+# Editable install for now (PyPI package will be `brasscoders`).
+pip install -e .
+
+# Verify:
+brasscoders --help
+```
+
+BrassCoders requires Python 3.10+ and pulls in `PyYAML`, `requests`, `bandit`,
+`pylint`, `radon`, `vulture`, `detect-secrets`, and `pyre-check` as runtime
+dependencies. The `requests` library is only used when you explicitly opt
+into network checks (see `--check-package-hallucination` below). `pyre-check`
+is pinned to a narrow version window (`>=0.9.25,<0.10`) because the Pysa
+model file format has been unstable across minors; bumping requires a
+verification pass on the bundled model lines.
+
+Python 3.10 is the minimum because the recommended Semgrep version
+(1.143.0+, for multicore parallelism — see below) is not available on
+PyPI for Python 3.9.
+
+**Optional**: install Semgrep for additional pattern-based taint detection.
+BrassCoders recommends version 1.143.0 or later, which enables multicore
+parallelism for ~3× faster scans on large repos:
+
+```bash
+pip install 'semgrep>=1.143.0'
+```
+
+## Supported platforms
+
+| OS | Status | Notes |
+|---|---|---|
+| macOS (Apple Silicon + Intel) | ✅ supported | Native; primary dev target |
+| Linux x86_64 | ✅ supported | Primary CI target |
+| Linux arm64 | ⚠️ partial | Every scanner except Pysa works natively. `pyre-check` ships a `pyre.bin` built for linux/amd64 only — Pysa skips with a clear status on arm64 Linux. |
+| Windows native | ❌ not supported | Use WSL2 |
+| Windows via WSL2 | ✅ supported | Treat as Linux |
+
+**Why Windows native isn't supported:**
+
+- The interprocedural taint scanner (Pysa) is built on Meta's Pyre, which has no Windows support.
+- `fcntl.flock` cache concurrency protection is Unix-only — BrassCoders warns and proceeds unlocked on Windows.
+- `ProcessPoolExecutor` batched Bandit/Pylint scanning was validated on `fork` (Linux/macOS); Windows `spawn` semantics are untested.
+
+Bringing Windows native to supported status is weeks-to-months of work (replace or sandbox Pyre/Pysa; add a Windows `flock` alternative; spawn-safe ProcessPool rewrites). Not on the v1 roadmap.
+
+For Docker users on Apple Silicon: pin `--platform linux/amd64` so Pyre's bundled binary runs under Rosetta emulation. See [`docs/CI.md`](docs/CI.md) for the recipe.
+
+## Usage
+
+```bash
+# One-shot scan of the current directory.
+brasscoders --offline scan
+
+# Watch mode: re-run incrementally on file changes.
+brasscoders --offline watch
+
+# Show last analysis summary.
+brasscoders status
+
+# Print version and which components are available.
+brasscoders version
+```
+
+### First-scan note: typeshed bootstrap for Pysa
+
+The interprocedural taint scanner (Pysa) needs Python's [typeshed](https://github.com/python/typeshed) stubs to resolve stdlib calls. BrassCoders doesn't bundle typeshed (~33 MB) and is offline-by-default, so on a fresh install Pysa skips with a clear "typeshed not found" status until you bootstrap it. The simplest path is the one-time autofetch flag:
+
+```bash
+# First scan only — let brass git-clone python/typeshed on demand.
+BRASS_AUTOFETCH_TYPESHED=1 brasscoders --offline scan
+```
+
+This makes one outbound `git clone` call to GitHub the first time (no other network use; the rest of `--offline` semantics still hold). Subsequent scans reuse the cached typeshed at `~/.cache/brass/typeshed/` with no network access.
+
+If your environment can't reach GitHub during scans, clone typeshed once into the cache location instead:
+
+```bash
+git clone --depth 1 https://github.com/python/typeshed ~/.cache/brass/typeshed
+```
+
+See [`docs/CACHE.md`](docs/CACHE.md) for the full typeshed-cache lifecycle.
+
+### Network policy
+
+BrassCoders is **offline by default**. The only outbound network surface is the
+package-hallucination check, which validates imported package names against
+PyPI / npm / pkg.go.dev. That check is disabled unless you pass
+`--check-package-hallucination`. Pass `--offline` to make absolutely sure
+nothing leaves your machine — it overrides the opt-in flag.
+
+```bash
+# Hard offline mode — nothing leaves your machine.
+brasscoders --offline scan
+
+# Opt in to the hallucination check (sends imported package names to public
+# registries; do not use on closed-source code with private imports).
+brasscoders scan --check-package-hallucination
+```
+
+### Scan modes
+
+```bash
+brasscoders scan --fast       # Quick: code analysis only, no privacy/content
+brasscoders scan --dev        # Source-only: skip tests/build artifacts
+brasscoders scan --code       # Just bugs / security / quality
+brasscoders scan --privacy    # Just PII detection
+brasscoders scan --content    # Just content moderation
+```
+
+## Performance and caching
+
+BrassCoders caches Pysa's call-graph state at `~/.cache/brass/pysa-state/` so repeat
+scans run 3–4× faster than cold. The cache is per-project, auto-invalidates on
+config drift, and is safe to delete at any time. See
+[`docs/CACHE.md`](docs/CACHE.md) for the full lifecycle (location, size profile,
+invalidation triggers, `BRASS_PYSA_CACHE_ROOT` env var, typeshed cache).
+
+Running BrassCoders in CI? See [`docs/CI.md`](docs/CI.md) for cache-mount recipes for
+GitHub Actions, GitLab CI, and CircleCI — without a cache mount, every CI run
+pays the full cold-scan cost.
+
+## Privacy & data handling
+
+- BrassCoders never sends your source code anywhere. The only outbound calls are
+  the optional package-hallucination registry checks described above.
+- The privacy scanner detects PII and writes findings to disk *with the
+  matched values redacted*. Raw matched text is replaced with a masked form
+  before serialization; raw context lines are dropped entirely.
+- The secret scanner records the secret *type* and a short hash for
+  de-duplication. The raw secret value is never persisted.
+- See [`docs/PRIVACY_POLICY.md`](docs/PRIVACY_POLICY.md) for the full
+  disclosure.
+
+## Architecture
+
+```
+CLI ──► Scanners ──► IntelligenceRanker ──► YAMLOutputGeneratorV2 ──► .brass/*.yaml
+```
+
+Each scanner is single-purpose and returns `List[Finding]`. The ranker
+weights and orders. The output generator writes atomic, owner-only YAML.
+There is no background process, no scheduler, and no inter-scanner
+communication.
+
+The `Finding` dataclass at `src/brass/models/finding.py` is the system's
+single contract; all builders, scanners, and the ranker depend on it but
+not on each other.
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).

brasscoders-2.0.4/README.md

@@ -0,0 +1,210 @@
+# BrassCoders — noise filter for AI-generated code
+
+BrassCoders scans a codebase and produces a small set of structured intelligence files
+(`.brass/*.yaml`) designed to be read by Claude Code, Cursor, or any other AI
+coding assistant. The goal is to surface what matters — real security risks,
+PII leaks, performance pitfalls — and hide what doesn't, so the AI's review
+stops drowning useful signal in low-confidence noise.
+
+BrassCoders is a one-shot CLI: it scans, writes the YAML, and exits. There is no
+background daemon, no telemetry by default, and no outbound network calls
+unless you opt in.
+
+## What it produces
+
+After `brasscoders scan`, you'll find these files in `.brass/`:
+
+| File | Purpose |
+|---|---|
+| `ai_instructions.yaml` | Top-level summary an AI should read first |
+| `detailed_analysis.yaml` | Every finding, grouped by type |
+| `file_intelligence.yaml` | Findings collated per file, ranked by priority |
+| `security_report.yaml` | Security-only view (secrets, injection, auth issues) |
+| `statistics.yaml` | Aggregate counts and severity distribution |
+| `privacy_analysis.yaml` | Privacy-only view (only when PII findings exist) |
+
+Output directory permissions are `0700`; individual files are `0600`. BrassCoders
+scans private source code, so this is enforced rather than opt-in.
+
+## What it detects
+
+| Category | Source |
+|---|---|
+| Secrets (AWS, Azure, GitHub, GitLab, Slack, Stripe, NPM, PEM, JWT, …) | [`detect-secrets`](https://github.com/Yelp/detect-secrets) |
+| Code-quality issues (complexity, dead code, common bugs) | Bandit + Pylint + Radon + AST patterns |
+| PII (credit card, SSN, IBAN, NHS, NINO, Aadhaar, PAN, NRIC, Medicare, TFN) | Pattern + Luhn-validated regex |
+| AI-coder anti-patterns (string concat in loops, insert-at-zero, nested loops, eval-on-input) | BrassCoders-specific AST analysis |
+| Authentication anti-patterns (hardcoded secrets, weak JWT, no rate limit) | BrassCoders-specific regex |
+
+Findings are de-duplicated and noise-filtered before they hit disk.
+
+## Supported languages
+
+BrassCoders is **Python-first**. The scanners that drive deepest analysis — Pysa
+(interprocedural taint), Bandit, Pylint, and the BrassCoders-specific AI-coder
+anti-pattern detectors — are Python-only.
+
+| Language | Coverage | Notes |
+|---|---|---|
+| Python | Full | Interprocedural taint, security, quality, anti-patterns |
+| JavaScript / TypeScript | Pattern-level | Intraprocedural Semgrep OSS rules; no interprocedural taint |
+| Other | Best-effort | Secrets detection and generic patterns where applicable |
+
+For JS-heavy applications that need deep taint analysis, BrassCoders should
+be paired with a JS-specific SAST (CodeQL, etc.). The BrassCoders team is
+tracking JS taint quality as a known pre-launch limitation.
+
+## Install
+
+```bash
+# Editable install for now (PyPI package will be `brasscoders`).
+pip install -e .
+
+# Verify:
+brasscoders --help
+```
+
+BrassCoders requires Python 3.10+ and pulls in `PyYAML`, `requests`, `bandit`,
+`pylint`, `radon`, `vulture`, `detect-secrets`, and `pyre-check` as runtime
+dependencies. The `requests` library is only used when you explicitly opt
+into network checks (see `--check-package-hallucination` below). `pyre-check`
+is pinned to a narrow version window (`>=0.9.25,<0.10`) because the Pysa
+model file format has been unstable across minors; bumping requires a
+verification pass on the bundled model lines.
+
+Python 3.10 is the minimum because the recommended Semgrep version
+(1.143.0+, for multicore parallelism — see below) is not available on
+PyPI for Python 3.9.
+
+**Optional**: install Semgrep for additional pattern-based taint detection.
+BrassCoders recommends version 1.143.0 or later, which enables multicore
+parallelism for ~3× faster scans on large repos:
+
+```bash
+pip install 'semgrep>=1.143.0'
+```
+
+## Supported platforms
+
+| OS | Status | Notes |
+|---|---|---|
+| macOS (Apple Silicon + Intel) | ✅ supported | Native; primary dev target |
+| Linux x86_64 | ✅ supported | Primary CI target |
+| Linux arm64 | ⚠️ partial | Every scanner except Pysa works natively. `pyre-check` ships a `pyre.bin` built for linux/amd64 only — Pysa skips with a clear status on arm64 Linux. |
+| Windows native | ❌ not supported | Use WSL2 |
+| Windows via WSL2 | ✅ supported | Treat as Linux |
+
+**Why Windows native isn't supported:**
+
+- The interprocedural taint scanner (Pysa) is built on Meta's Pyre, which has no Windows support.
+- `fcntl.flock` cache concurrency protection is Unix-only — BrassCoders warns and proceeds unlocked on Windows.
+- `ProcessPoolExecutor` batched Bandit/Pylint scanning was validated on `fork` (Linux/macOS); Windows `spawn` semantics are untested.
+
+Bringing Windows native to supported status is weeks-to-months of work (replace or sandbox Pyre/Pysa; add a Windows `flock` alternative; spawn-safe ProcessPool rewrites). Not on the v1 roadmap.
+
+For Docker users on Apple Silicon: pin `--platform linux/amd64` so Pyre's bundled binary runs under Rosetta emulation. See [`docs/CI.md`](docs/CI.md) for the recipe.
+
+## Usage
+
+```bash
+# One-shot scan of the current directory.
+brasscoders --offline scan
+
+# Watch mode: re-run incrementally on file changes.
+brasscoders --offline watch
+
+# Show last analysis summary.
+brasscoders status
+
+# Print version and which components are available.
+brasscoders version
+```
+
+### First-scan note: typeshed bootstrap for Pysa
+
+The interprocedural taint scanner (Pysa) needs Python's [typeshed](https://github.com/python/typeshed) stubs to resolve stdlib calls. BrassCoders doesn't bundle typeshed (~33 MB) and is offline-by-default, so on a fresh install Pysa skips with a clear "typeshed not found" status until you bootstrap it. The simplest path is the one-time autofetch flag:
+
+```bash
+# First scan only — let brass git-clone python/typeshed on demand.
+BRASS_AUTOFETCH_TYPESHED=1 brasscoders --offline scan
+```
+
+This makes one outbound `git clone` call to GitHub the first time (no other network use; the rest of `--offline` semantics still hold). Subsequent scans reuse the cached typeshed at `~/.cache/brass/typeshed/` with no network access.
+
+If your environment can't reach GitHub during scans, clone typeshed once into the cache location instead:
+
+```bash
+git clone --depth 1 https://github.com/python/typeshed ~/.cache/brass/typeshed
+```
+
+See [`docs/CACHE.md`](docs/CACHE.md) for the full typeshed-cache lifecycle.
+
+### Network policy
+
+BrassCoders is **offline by default**. The only outbound network surface is the
+package-hallucination check, which validates imported package names against
+PyPI / npm / pkg.go.dev. That check is disabled unless you pass
+`--check-package-hallucination`. Pass `--offline` to make absolutely sure
+nothing leaves your machine — it overrides the opt-in flag.
+
+```bash
+# Hard offline mode — nothing leaves your machine.
+brasscoders --offline scan
+
+# Opt in to the hallucination check (sends imported package names to public
+# registries; do not use on closed-source code with private imports).
+brasscoders scan --check-package-hallucination
+```
+
+### Scan modes
+
+```bash
+brasscoders scan --fast       # Quick: code analysis only, no privacy/content
+brasscoders scan --dev        # Source-only: skip tests/build artifacts
+brasscoders scan --code       # Just bugs / security / quality
+brasscoders scan --privacy    # Just PII detection
+brasscoders scan --content    # Just content moderation
+```
+
+## Performance and caching
+
+BrassCoders caches Pysa's call-graph state at `~/.cache/brass/pysa-state/` so repeat
+scans run 3–4× faster than cold. The cache is per-project, auto-invalidates on
+config drift, and is safe to delete at any time. See
+[`docs/CACHE.md`](docs/CACHE.md) for the full lifecycle (location, size profile,
+invalidation triggers, `BRASS_PYSA_CACHE_ROOT` env var, typeshed cache).
+
+Running BrassCoders in CI? See [`docs/CI.md`](docs/CI.md) for cache-mount recipes for
+GitHub Actions, GitLab CI, and CircleCI — without a cache mount, every CI run
+pays the full cold-scan cost.
+
+## Privacy & data handling
+
+- BrassCoders never sends your source code anywhere. The only outbound calls are
+  the optional package-hallucination registry checks described above.
+- The privacy scanner detects PII and writes findings to disk *with the
+  matched values redacted*. Raw matched text is replaced with a masked form
+  before serialization; raw context lines are dropped entirely.
+- The secret scanner records the secret *type* and a short hash for
+  de-duplication. The raw secret value is never persisted.
+- See [`docs/PRIVACY_POLICY.md`](docs/PRIVACY_POLICY.md) for the full
+  disclosure.
+
+## Architecture
+
+```
+CLI ──► Scanners ──► IntelligenceRanker ──► YAMLOutputGeneratorV2 ──► .brass/*.yaml
+```
+
+Each scanner is single-purpose and returns `List[Finding]`. The ranker
+weights and orders. The output generator writes atomic, owner-only YAML.
+There is no background process, no scheduler, and no inter-scanner
+communication.
+
+The `Finding` dataclass at `src/brass/models/finding.py` is the system's
+single contract; all builders, scanners, and the ranker depend on it but
+not on each other.
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).