cloak-cli 0.1.0__tar.gz

cloak_cli-0.1.0/.cloakpolicy.example

@@ -0,0 +1,67 @@
+# .cloakpolicy — example/template
+#
+# Drop this file at your repo root as `.cloakpolicy` and edit to match your project.
+# Whoever has merge access to this file controls CLOAK policy. Audit changes via `git log`.
+#
+# Run `cloak policy preview ./src` to see what this policy would redact (Phase 1+).
+
+version: 1
+
+# ---------------------------------------------------------------------------
+# Paths CLOAK treats with extra care. Globs match against paths relative to
+# the repo root. Anything matching is flagged as `sensitive` by `cloak scan`
+# and aggressively redacted by `cloak context` / `cloak obfuscate`.
+# ---------------------------------------------------------------------------
+sensitive_paths:
+  - "src/pricing/**"
+  - "src/auth/**"
+  - "config/secrets/**"
+
+# ---------------------------------------------------------------------------
+# Names that must NEVER be renamed by `cloak obfuscate`. Use this for public
+# API surface that other modules or external callers depend on. Supports
+# fully-qualified names and trailing wildcards.
+# ---------------------------------------------------------------------------
+public_api:
+  - "QuoteEngine.calculate_quote"
+  - "AuthService.authenticate"
+  - "PaymentGateway.*"
+
+# ---------------------------------------------------------------------------
+# Custom secret-detection rules layered on top of the built-in scanner
+# (which wraps detect-secrets / gitleaks). Use this for company-specific
+# patterns the upstream scanners won't catch.
+# ---------------------------------------------------------------------------
+secret_rules:
+  - id: internal_api_endpoint
+    pattern: 'https?://internal\..*\.corp\.example'
+    severity: high
+  - id: customer_id_pattern
+    pattern: 'CUST-[A-Z]{3}-\d{6}'
+    severity: medium
+
+# ---------------------------------------------------------------------------
+# Strings safe to keep un-redacted (won't be encoded by `cloak obfuscate`).
+# Useful for license headers, public doc URLs, etc.
+# ---------------------------------------------------------------------------
+allow_strings:
+  - "https://docs.example.com/*"
+  - "Apache-2.0"
+
+# ---------------------------------------------------------------------------
+# Default behavior of `cloak context` (redacted markdown for LLM paste).
+# ---------------------------------------------------------------------------
+context_defaults:
+  keep_docstrings: true
+  redact_function_bodies: true
+  alias_enums: false           # set true to behave like --strict by default
+
+# ---------------------------------------------------------------------------
+# Default behavior of `cloak obfuscate` (transformed copy for sharing).
+# ---------------------------------------------------------------------------
+obfuscate_defaults:
+  rename_private: true
+  rename_public_api: false
+  encode_strings: false        # opt-in only — strings are often SQL/log keys
+  strip_docstrings: false
+  profile: standard            # or "aggressive"

cloak_cli-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package + dev deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: ruff format
+        run: ruff format --check .
+
+      - name: ruff lint
+        run: ruff check .
+
+      - name: mypy --strict
+        run: mypy src/cloak
+
+      - name: pytest
+        run: pytest -v

cloak_cli-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,67 @@
+name: release
+
+# Publishes the package to PyPI when a tag matching `v*` is pushed.
+#
+# One-time setup before the FIRST release works:
+#   1. Create a PyPI account (https://pypi.org/account/register/) if needed.
+#   2. Reserve the project name with a "pending Trusted Publisher":
+#        https://pypi.org/manage/account/publishing/
+#      Fill in:
+#        PyPI Project Name:    cloak-cli  (the simpler `cloak` was taken; CLI binary is still `cloak`)
+#        Owner:                newtophilly
+#        Repository name:      cloak
+#        Workflow filename:    release.yml
+#        Environment name:     pypi
+#   3. In this repo settings, create the `pypi` environment under
+#      Settings → Environments → New environment → "pypi" (no extra config needed).
+#   4. Tag and push:  git tag v0.1.0 && git push origin v0.1.0
+#
+# After the first publish, the trusted publisher becomes "active" and subsequent
+# releases need only a new tag push. NO API tokens or secrets are stored in the repo.
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install build
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build sdist + wheel
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cloak-cli
+    permissions:
+      id-token: write   # required for Trusted Publisher (OIDC)
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

cloak_cli-0.1.0/.gitignore

@@ -0,0 +1,51 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+.venv/
+venv/
+env/
+ENV/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Type checkers / linters / coverage
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Editors / OS
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store
+Thumbs.db
+
+# Personal infrastructure (not part of the project)
+.agent-bridge/
+.claude/
+
+# Test outputs / scratch
+*.cloaked/
+cloak-manifest.json
+.cloak-cache/

cloak_cli-0.1.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-05-08
+
+First tagged alpha. All three headline commands (`scan`, `context`, `obfuscate`) are functional for Python.
+
+### Added
+- GitHub Actions CI workflow: ruff format/check + mypy --strict + pytest, matrix across Python 3.11/3.12/3.13.
+- GitHub Actions release workflow: tag-triggered (`v*`) build of sdist + wheel, publish to PyPI via Trusted Publisher (OIDC, no stored tokens).
+- `pyproject.toml` switched to dynamic version sourced from `src/cloak/__init__.py` (single source of truth).
+- README CI / license / Python-version badges.
+- README "real example" section with three concrete day-in-the-life flows.
+- CONTRIBUTING.md release runbook (one-time PyPI Trusted Publisher setup + per-release tag steps).
+- Phase 0: validation experiment proving the redaction strategy on a fake industrial-automation pricing engine. Documented in `docs/research/`.
+- Phase 1: package scaffold, `typer`-based CLI with `scan`, `context`, `obfuscate` subcommands, `.cloakpolicy` YAML loader, `.cloakignore` support, repo walker, smoke tests.
+- Phase 2: `cloak scan` is now functional. Wraps `detect-secrets` and layers in `policy.secret_rules` custom regex rules. Returns structured `Finding` records with severity, file, line, rule_id, redacted preview, and suggested action. Raw secrets are never printed — every preview is redacted via `_redact()`. "Clean bill of health" terminal panel when no findings; rich table when findings exist. Exit code 1 on findings, 0 on clean. JSON contract documented in `docs/AGENT_INTEGRATION.md`.
+- Phase 4 (Python v1): `cloak obfuscate` is now functional with `--verify`. Renames module-private identifiers (`_names`) within each file, skipping `policy.public_api` matches and dunders, optionally strips docstrings per `policy.obfuscate_defaults.strip_docstrings`. Pipeline copies non-Python files unchanged, writes `cloak-manifest.json` (sha256 of every source/output file, rename map keyed `path:original`, policy snapshot + hash, verify command and result, version + timestamp), and runs the user-supplied `--verify` shell command in the output dir. Exit code 1 on verify failure (output is still written for inspection but the UX warns clearly). Refuses to overwrite a non-empty output directory. v1 deferred (documented in source): cross-file renames, class-method renames, string encoding, control-flow flattening (aggressive profile).
+- Phase 3 (Python): `cloak context` is now functional for Python files. AST-based redactor replaces function/method bodies with `...` (stub-file convention), redacts module-level UPPER_SNAKE constants holding dict/list/set/tuple literals (the "proprietary tables" pattern from the Phase 0 case study), preserves imports, class shapes, signatures, and docstrings. `--strict` mode aliases enum values to opaque names (`NORTHEAST = 'NE'` → `VALUE_0 = 'V0'`) and strips all docstrings — justified by the Phase 0 adversarial probe finding. CLI supports `--out FILE`, `--copy` (best-effort across pbcopy/xclip/wl-copy/clip.exe), and `--json` status mode. Generated markdown carries a stable header comment with version, policy source, and strict flag for downstream tooling. JS/TS lands in Phase 3.5 via tree-sitter.
+- `docs/AGENT_INTEGRATION.md`: agent-readable integration spec for tools that call CLOAK as a subprocess (Codex, Claude, custom).
+- README "Integrations" section linking fob and the agent guide.
+- Build plan and competitive landscape research published in `docs/`.

cloak_cli-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to CLOAK
+
+Thanks for considering a contribution. CLOAK is an alpha-stage open-source project; the easiest ways to help are issues, small focused PRs, and feedback on the build plan.
+
+## Development setup
+
+Requirements: Python 3.11+ and `pip`.
+
+```bash
+git clone https://github.com/newtophilly/cloak.git
+cd cloak
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## Code style
+
+- Format and lint with `ruff` (`ruff format . && ruff check .`)
+- Type-check with `mypy src/cloak`
+- Tests with `pytest`
+
+CI will run all three. Please keep them green before opening a PR.
+
+## What to work on
+
+Open issues are labeled by area (`scan`, `context`, `obfuscate`, `policy`, `cli`) and difficulty. New contributors should look for `good-first-issue`. The roadmap lives in [`docs/BUILD_PLAN.md`](docs/BUILD_PLAN.md) — read that first to understand how a piece of work fits.
+
+## Honest positioning
+
+CLOAK markets itself as a **governance + friction** tool, not unbreakable protection. PRs that overclaim what obfuscation achieves (in code, comments, docs, or marketing copy) will be redirected. See the README's "What CLOAK is NOT" section for the line. This is not pedantry — it's the position that distinguishes CLOAK from the dishonest end of the obfuscation market.
+
+## Reporting security issues
+
+Please do **not** file public issues for security vulnerabilities. Open a private security advisory at https://github.com/newtophilly/cloak/security/advisories/new with details, and we'll respond as quickly as we can.
+
+## Releasing (maintainers)
+
+CLOAK is published to PyPI via a GitHub Actions workflow that runs on tag pushes (`v*`). PyPI authentication uses a [Trusted Publisher](https://docs.pypi.org/trusted-publishers/) — no tokens stored in the repo.
+
+**One-time setup (first release only):**
+
+1. Create the project on PyPI as a *pending* Trusted Publisher:
+   - https://pypi.org/manage/account/publishing/
+   - PyPI Project Name: `cloak-cli` (the `cloak` name was already taken; the CLI binary on `$PATH` is still `cloak`)
+   - Owner: `newtophilly`
+   - Repository name: `cloak`
+   - Workflow filename: `release.yml`
+   - Environment name: `pypi`
+2. Create the `pypi` GitHub environment in this repo:
+   - Settings → Environments → New environment → name `pypi`. No extra config needed.
+
+**Per-release steps:**
+
+1. Bump `__version__` in `src/cloak/__init__.py` (single source of truth — `pyproject.toml` reads from this file via `[tool.hatch.version]`).
+2. Add a CHANGELOG entry under `[Unreleased]`, then move it under a new versioned heading.
+3. Commit. Wait for `ci` to go green on `main`.
+4. Tag and push: `git tag v<VERSION> && git push origin v<VERSION>`.
+5. The `release` workflow builds an sdist + wheel and publishes them to PyPI.
+
+If the first release fails, the most likely cause is a step missed in the one-time setup above (pending Trusted Publisher not registered, or the `pypi` environment doesn't exist).
+
+## Commit / PR conventions
+
+- One logical change per PR. If you find unrelated cleanup along the way, prefer a separate PR.
+- Commit messages: short imperative subject (≤ 72 chars), optional body explaining *why*.
+- Include tests for new behavior. Include a docs update for any user-facing change.

cloak_cli-0.1.0/LICENSE

@@ -0,0 +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 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 Support. 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 support.
+
+   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 CLOAK contributors
+
+   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.