@cleak/cli 0.1.0

package/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 reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Le Dang Dung
+
+   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/NOTICE

@@ -0,0 +1,11 @@
+cleak
+Copyright 2026 Le Dang Dung
+
+This product includes software developed for a Master's thesis on
+LLM-orchestrated C/C++ memory-leak investigation.
+
+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

package/README.md

@@ -0,0 +1,130 @@
+# cleak
+
+An agentic terminal investigator for C/C++ memory leaks. It drives static/dynamic
+analysis MCP servers with a native tool-calling loop — the model decides which
+analyses to run on each allocation candidate, gathers evidence, and records a
+verdict — then renders JSON / Markdown / HTML / snapshot reports. One binary, two
+surfaces (interactive TUI + headless batch), reproducible artifacts per scan.
+
+## Install
+
+```bash
+npm i -g @cleak/cli     # or: bun add -g @cleak/cli  ·  pnpm add -g @cleak/cli
+# the installed command is still `cleak`
+```
+
+Then:
+
+```bash
+cleak tui                                        # interactive terminal UI
+cleak scan --repo <path> --mode llm_assisted     # headless scan → results/<scanId>/
+cleak tools                                      # check analyzer MCP connectivity
+cleak eval --corpus <path>                       # batch-evaluate a labeled corpus
+```
+
+`cleak` needs the two analyzer MCP servers reachable (default `localhost:50061` /
+`50062`) — start them with `docker compose up` from the repo, or point at remote
+ones via `--static-url` / `--dynamic-url`. The LLM key/provider is read from
+`<cwd>/.env` or env vars (`LLM_PROVIDER`, `LOCAL_LLM_API_KEY` / `OPENAI_API_KEY` / …).
+
+### From source (this monorepo)
+
+```bash
+bun run cleak:install     # build the self-contained bundle + npm i -g it
+```
+
+## Architecture
+
+```
+packages/agent-core         framework-free agentic core (reusable):
+  loop.ts                   async-generator turn loop (stream → tools → results → repeat)
+  tool.ts                   Tool abstraction + buildTool() defaults
+  providers/                callModel for local | openai | anthropic (native tool-calling)
+  mcp/                      Streamable-HTTP MCP client + tool wrapping (tools/list → Tool)
+
+apps/leak-inspector-tui
+  domain/                   systemPrompt, domain tools (read_file, record_verdict, …),
+                            CandidateManager, path resolver, heuristic judge wrapper
+  orchestrator/             HYBRID scan controller + ScanEvent emitter + investigation phase
+  surfaces/headless.ts      batch runner → results/<scanId>/ + JSONL event log
+  surfaces/tui/             Ink UI (timeline, tool cards, spinner, permission overlay)
+
+packages/common/analysis    shared report renderers + heuristic analysis + heuristic
+                            judge + consensus judge (the leak-vs-clean decision boundary)
+```
+
+### HYBRID orchestration
+
+```
+discovery (deterministic: indexFiles + candidateScan)
+  → investigation (agentic native tool-calling loop; llm_assisted only)
+  → judging (deterministic heuristic finalizer for un-verdicted bundles)
+  → reporting (json / markdown / html / snapshot)
+```
+
+Deterministic discovery + judging keep the candidate set and verdict synthesis
+reproducible; the investigation phase is where the model is genuinely agentic.
+
+## Usage
+
+Start the analyzers in MCP mode (they default to gRPC):
+
+```bash
+(cd apps/static-analyzer  && TRANSPORT_MODE=mcp MCP_HTTP_PORT=50061 bun run dev)
+(cd apps/dynamic-analyzer && TRANSPORT_MODE=mcp MCP_HTTP_PORT=50062 bun run dev)
+```
+
+Then:
+
+```bash
+# discover/verify analyzer tools
+bun apps/leak-inspector-tui/src/cli.ts tools
+
+# headless scan (writes results/<scanId>/)
+bun apps/leak-inspector-tui/src/cli.ts scan --repo demo/memory_leak_corpus/early_return_leak --mode llm_assisted
+
+# interactive TUI (needs a terminal)
+bun apps/leak-inspector-tui/src/cli.ts tui
+#   /scan <path>  /mode no_llm|llm_assisted  /dynamic off|selective|aggressive  /report  /tools  /quit
+```
+
+### Outputs (`results/<scanId>/`)
+
+- `snapshot.json` — compact, machine-comparable findings (thesis evaluation format)
+- `report.json` / `report.md` / `report.html` — full report
+- `events.jsonl` — the ScanEvent stream (phase + agent activity)
+- `transcript.json` — the full agent message history (reproducibility / audit)
+
+## Configuration (env)
+
+| var | meaning | default |
+|---|---|---|
+| `LLM_PROVIDER` | `local` \| `openai` \| `anthropic` | `local` |
+| `LOCAL_LLM_BASE_URL` / `LOCAL_LLM_MODEL` / `LOCAL_LLM_API_KEY` | local OpenAI-compatible gateway | `localhost:20128/v1` |
+| `STATIC_ANALYZER_MCP_URL` / `DYNAMIC_ANALYZER_MCP_URL` | analyzer endpoints | `localhost:50061` / `:50062` |
+| `AGENT_MAX_TURNS` | investigation turn budget | `15` |
+
+The LLM key is read from the repo-root `.env` (or `apps/leak-inspector-tui/.env`)
+automatically (the TUI loads it on start). Host runs rewrite
+`host.docker.internal` → `localhost`; set `IN_CONTAINER=1` to keep the container
+hostname.
+
+## Thesis experiment scripts
+
+```bash
+bun scripts/evaluate-corpus.ts [no_llm|llm_assisted] [limit]   # score vs expected_leak_count
+bun scripts/compare-modes.ts [limit]                           # no_llm vs llm_assisted
+bun scripts/run-local-scan-smoke.ts                            # one-scan sanity check
+bun scripts/mcp-contract-test.ts                               # analyzer tool catalog check
+```
+
+## Notes
+
+- **Dynamic analysis** (sanitizers / valgrind) and the **Clang-SA / scan-build**
+  deep-static slot require Linux/Docker; on macOS the analyzers run those phases
+  inside the container. The agent gates them behind `--dynamic` and interactive
+  approval. (The "leakguard" tool slot now runs Clang scan-build, not the removed
+  LeakGuard third-party tool.)
+- In a dev box where the docker stack already holds `50061/50062` in gRPC mode,
+  run the MCP analyzers on alternate ports (e.g. `50071/50072`) and pass
+  `--static-url` / `--dynamic-url`.