Metadata-Version: 2.4
Name: perla
Version: 0.1.59
Summary: Pre-push risk check + cloud-connected CLI for LocAgent. Maps your local diff to its dependency blast radius and checks it against your team's incident memory.
Author: LocAgent contributors
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.
        
Project-URL: Homepage, https://github.com/Matiyas-H/Perla-cli
Project-URL: Repository, https://github.com/Matiyas-H/Perla-cli
Project-URL: Issues, https://github.com/Matiyas-H/Perla-cli/issues
Project-URL: Changelog, https://github.com/Matiyas-H/Perla-cli/blob/main/CHANGELOG.md
Keywords: cli,code-review,pre-commit,git-hook,dependency-graph,tree-sitter,incident,risk
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx<1.0,>=0.27
Requires-Dist: networkx<4.0,>=3.4
Requires-Dist: tree-sitter<0.26,>=0.25.2
Requires-Dist: tree-sitter-language-pack!=1.8.0,<2.0,>=1.6.0
Requires-Dist: pydantic<3.0,>=2.9
Requires-Dist: llama-index-core<0.12,>=0.11
Requires-Dist: llama-index-retrievers-bm25<0.5,>=0.4
Requires-Dist: PyStemmer>=2.2
Requires-Dist: rapidfuzz>=3.0
Requires-Dist: libcst>=1.0
Requires-Dist: psutil>=5.9
Requires-Dist: tqdm>=4.66
Requires-Dist: unidiff>=0.7
Requires-Dist: rich<15,>=13.0
Requires-Dist: litellm<2.0,>=1.50
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-cov>=5.0; extra == "dev"
Provides-Extra: agent
Dynamic: license-file

# perla

**LocAgent's developer CLI: triage incidents and catch risky changes — from your terminal.**

`perla` brings two LocAgent workflows into your shell:

1. **Triage** an error / stack trace / failed CI run from the command line — the agent reads your code, finds the root cause, and (when you want) opens a fix PR. No dashboard required.
2. **Pre-push risk check** — before you push, `perla preflight` maps your local diff to its dependency blast radius and checks it against your team's incident history. Changes that touch the exact function that broke production last quarter get flagged with a real reason.

Both run against your LocAgent workspace and reuse the memory you've built up there.

## Two flows

### Triage from the terminal

```
$ perla recall "TypeError: cannot read 'id' of undefined in checkout"
  Found 2 similar past incident(s):
    • [91%] Null deref in checkout.finalize — unguarded session lookup
        files: services/checkout.py
        id: cmp_inv618

$ perla investigate "NPE in checkout.finalize at deploy 4f7c2" --follow
  ⠋ Investigating omnia-v/omnia…
  ✓ Root cause: services/checkout.py:142 — unguarded session lookup
    Causes:
      [root]        services/checkout.py:finalize
      [contributing] services/auth.py:resolve_session
  → https://app.locagent.dev/.../investigations/cmp_inv719

$ perla fix cmp_inv719
  Generating fix… (1-3 minutes)
  ✓ Fix PR opened: https://github.com/your-org/your-repo/pull/718
```

`investigate` / `recall` / `show` / `ls` / `fix` — the whole triage loop, from terminal to merged fix.

### Pre-push risk check

```
$ perla preflight

  Changed entities & blast radius:
    • services/checkout.py:finalize  (function) ← 12 dependents  ⚠ high fan-in

  Memory: checked (47 past incidents scanned)
    ⚠ Null deref in checkout.finalize — unguarded session lookup [cmp_inv618]

  Verdict: ⚠ RISKY  (cloud)
    - Removes the None-guard that was added in incident #618
    - 12 entities depend on this function (payment, mobile, admin)
    → Re-add the session guard before pushing.
```

Exit code `1` on RISKY — drop it in a pre-push git hook or a CI step and it gates the push.

---

## Install

```bash
uv tool install perla         # recommended
pipx install perla            # or pipx
pip install perla             # or pip
```

Requires Python 3.12+. The CLI works fully offline for local code intelligence and only talks to the cloud when you ask it to (see [verdict modes](#three-verdict-modes) below).

## First run, in 60 seconds

```bash
# 1. Offline / no setup — works in any git repo
cd ~/some-git-repo
# (make a code change)
perla preflight --no-memory --verdict-mode local

# 2. Connect to your workspace for memory-grounded verdicts
perla login                   # paste a workspace API key from the dashboard
perla preflight               # now uses the cloud verdict + incident memory
```

## The 13 commands

### Triage — agent reads your code, finds the cause, opens the PR

| | |
|---|---|
| `perla recall "<error>"` | "Have we seen this before?" — semantic search across your workspace's incident memory. |
| `perla investigate "<text>" [--follow]` | Dispatch a full triage. `--follow` polls to completion and prints the briefing. |
| `perla show <id>` | Read an investigation + its briefing (root cause, contributors, files). |
| `perla ls` | List recent investigations. |
| `perla fix <id>` | Open a fix PR from a triaged finding (patch-on-demand). |

### Pre-push risk check

| | |
|---|---|
| `perla preflight` | Diff → blast radius → memory lookup → verdict. Exit `1` on risky for git-hook / CI use. |

### Local code intelligence — works offline, no login

| | |
|---|---|
| `perla build [path]` | Build a dependency graph of a repo (tree-sitter → NetworkX). |
| `perla search <query>` | BM25 + fuzzy code search over the graph. |
| `perla explore <entity>` | Traverse the graph: callers, callees, importers. |
| `perla blame <entity>` | Git temporal forensics — who last touched it, when. |

### Connection

| | |
|---|---|
| `perla login` | Paste a workspace API key (`loc_...`); stored 0600 at `~/.config/perla/credentials.json`. |
| `perla whoami` | Show the connected workspace + repos. |
| `perla logout` | Remove stored credentials. |

## Three verdict modes

`perla preflight --verdict-mode <mode>` — the customer chooses the trust posture:

| Mode | Where the diff goes | Use when |
|---|---|---|
| `cloud` *(default)* | The LocAgent worker. Same trust model as auto-PR. | Best verdict quality; you're OK sending diffs to the workspace. |
| `byok` | Your own model provider (OpenAI / Anthropic / Ollama / any OpenAI-compatible). | You want LLM reasoning but no third party seeing your code. |
| `local` | Nowhere. Rule-based blast-radius reasoning, no model. | Offline, CI without keys, the deterministic floor. |

Any model/connection failure degrades to the local floor automatically — `perla preflight` never hard-fails.

## Use in CI

```yaml
# .github/workflows/preflight.yml
- run: pip install perla
- run: perla preflight --json     # exit 1 on risky → gates the job
  env:
    PERLA_API_KEY: ${{ secrets.PERLA_API_KEY }}
```

Or pre-push hook:
```bash
# .git/hooks/pre-push
#!/bin/sh
perla preflight || exit $?
```

The `--json` envelope is a stable contract — top-level fields, the per-entity
`scored` array with file:line evidence for every red flag. Full schema in
[`docs/JSON-SCHEMA.md`](docs/JSON-SCHEMA.md), including `jq` recipes for
common CI patterns (gate on specific flags, emit GitHub annotations, detect
cache state).

## Environment variables

| Var | When | What |
|---|---|---|
| `PERLA_API_KEY` | CI / scripts | Workspace API key; overrides `perla login` |
| `PERLA_BASE_URL` | Self-hosted dashboard | LocAgent dashboard base URL |
| `PERLA_LLM_KEY` | `byok` mode | Your own model provider key |
| `PERLA_LLM_BASE_URL` | `byok` non-OpenAI | OpenAI-compatible base (Anthropic, Ollama, etc.) |
| `PERLA_LLM_MODEL` | `byok` | Defaults to `gpt-4o-mini` |
| `PERLA_LLM_TIMEOUT_SECONDS` | agent mode | Per-LLM-call timeout before the local agent aborts a stalled provider call (default `60`) |
| `PERLA_LLM_MAX_RETRIES` | agent mode | Retries for transient LLM failures/timeouts (default `1`) |
| `PERLA_REPOSITORY_ID` | rare | Override the auto-resolved workspace repo |
| `PERLA_CONFIG_DIR` | rare | Credentials file location (defaults to XDG) |

## Privacy posture

- **Local mode:** diff never leaves the machine.
- **BYO mode:** diff goes to *your* model provider; LocAgent's cloud only ever sees file/entity *names* (for the memory lookup).
- **Cloud mode:** diff goes to your LocAgent workspace runtime — the same place auto-PR sends already-pushed code.

The cloud memory lookup (`preflight-memory`, `recall`) always sends only paths and entity names — never source.

## How it works

```
                                    ┌─────────────────────┐
git diff (working tree, uncommitted)│  perla (local)      │
        ↓                           │                     │
changed files + line ranges         │  tree-sitter graph  │
        ↓                           │  ────────────────►  │
graph node spans → changed entities │  reverse-BFS deps   │
        ↓                           └──────────┬──────────┘
blast radius (who depends on them)             │
        ↓                                       │
        │  file/entity names only ─────────────►│ LocAgent workspace
        │                                       │  (incident memory)
        │  ◄───── prior incidents ──────────────│
        ↓                                       │
verdict (cloud / byok / local) ─────────────────┘
```

`perla` ships **only** the local graph engine (`dependency_graph`, `tree-sitter`) plus a thin HTTP client. No FastAPI service, no agent loop, no LLM bundled — `cloud` mode dispatches to your LocAgent worker, `byok` calls your provider directly.

## Status

Beta. The 4 core modules (`preflight`, `verdict`, `workspace`, `auth`) ship at 100% test coverage. The full surface is exercised end-to-end against a real workspace in our internal CI. Breaking changes possible before 1.0; see [CHANGELOG.md](./CHANGELOG.md).

## Links

- **Issues:** https://github.com/Matiyas-H/Perla-cli/issues
- **LocAgent platform:** https://locagent.dev
- **License:** Apache 2.0 — see [LICENSE](./LICENSE)
