Metadata-Version: 2.4
Name: risqlet
Version: 0.2.0
Summary: Agent-facing risk analysis, mitigation and test-strategy toolkit: repo-native risk register with a deterministic CLI core
Project-URL: Homepage, https://github.com/manykarim/risqlet
Project-URL: Repository, https://github.com/manykarim/risqlet
Project-URL: Issues, https://github.com/manykarim/risqlet/issues
Project-URL: Changelog, https://github.com/manykarim/risqlet/blob/main/CHANGELOG.md
Author-email: Many Karim <many.kasiriha@gmail.com>
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.
License-File: LICENSE
License-File: LICENSE-CATALOG
License-File: NOTICE
Keywords: agent,coding-agent,fmea,mcp,quality-assurance,risk-analysis,risk-based-testing,test-strategy
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.12
Requires-Dist: pydantic>=2.7
Requires-Dist: ruamel-yaml>=0.18
Provides-Extra: mcp
Requires-Dist: mcp>=1.2; extra == 'mcp'
Description-Content-Type: text/markdown

# risqlet

Agent-facing risk analysis, mitigation and test-strategy toolkit for software projects.

`risqlet` gives coding agents and humans a shared, repo-native risk register (`.risqlet/`)
plus a deterministic CLI that owns everything an LLM must never do by itself:
schema validation, score arithmetic, priority ranking, lifecycle gates, and exports.
Semantic work — eliciting risks, phrasing statements, proposing mitigations — stays
with the host agent (the *framework-provider* pattern).

It also generates repo-grounded test strategies, ingests test results to keep
mitigations honest, re-assesses risk at the PR/CI boundary, and turns accepted
mitigations into coding-agent guardrails. The architecture is fixed by the two
deep-research reports in `docs/`; design history lives in `openspec/`.

## Design in one paragraph

All state lives in files under `.risqlet/` (file-per-risk YAML, append-only decision
log, config) — no server, no sessions, git is the database. Any coding agent that can
run a shell command can use it; Agent Skills, hooks and an MCP adapter layer on top.
Risk lifecycle transitions require a named human principal recorded in the event log:
agents propose, humans decide.

## Quick start

```bash
pip install risqlet        # or: uv tool install risqlet
risqlet setup              # configure your coding agents (skills, MCP, rules)
risqlet init               # scaffold .risqlet/ in your project
risqlet status             # where the analysis stands
```

`risqlet setup` is the one-command onboarding. It detects your coding agents and
wires each one up at project or global scope, then `risqlet setup --remove`
cleanly reverses it. It works both interactively and headlessly:

```bash
risqlet setup                                   # interactive: pick agents + scope
risqlet setup --agents claude,cursor --yes      # scriptable / CI (no prompts)
risqlet setup --all-detected --scope global     # configure every detected agent
risqlet setup --status                          # what's installed where
risqlet setup --remove                          # clean uninstall
```

Supported agents: **Claude Code** (full — skills, MCP, instructions, hooks,
commands) plus an instructions + MCP tier (and skills where supported) for
**Cursor, opencode, Codex, Copilot, kilo, pi**. Each gets exactly what it
supports, reported honestly; MCP-global-only agents (Codex, pi) are flagged.

Core workflow once set up:

```bash
risqlet validate            # schema + lifecycle + gate checks
risqlet score --all         # compute derived priorities from the active policy pack
risqlet export --fmt strategy-md
risqlet catalog list        # browse the knowledge packs
```

## The `.risqlet/` register format

```
.risqlet/
├── config.yaml       # project, active catalogs, scoring policy, phase, constraints,
│                     # selected quality aspects (max 6 by default)
├── register/
│   └── R-0001.yaml   # one risk per file: statement, aspects, elicited_by provenance,
│                     # scores (values + rubric_anchors; derived is CLI-owned),
│                     # status lifecycle, embedded mitigations (residual_note required)
├── events.jsonl      # append-only decision log; status/phase transitions need
│                     # a `human:` principal — agents propose, humans decide
├── policies/         # optional user scoring-policy packs (shadow packaged ones)
└── strategy.md       # conventional target for `risqlet export --fmt strategy-md -o`
```

JSON Schemas for all file types are published in `src/risqlet/schemas/` (generated
from the models via `python -m risqlet.model.schema_gen`). Unknown extra fields are
warnings, not errors — the format is open for forward-compatible annotation.

Every file is **UTF-8 with `\n` line endings**, on every platform — risqlet states
the encoding rather than inheriting the host's locale, so a register written on
Windows is byte-identical to one written on Linux and survives a round trip through
either. This is part of the on-disk contract: the register is meant to be diffed,
reviewed, and merged in git, which only works if the bytes do not depend on who
wrote them.

Scoring policies are data, not code (`src/risqlet/policies/packs/`): ordinal factors
plus derived fields via a `product` formula or a top-down first-match lookup table.
Default is `sod-ap-v1` (Severity×Occurrence×Detection with severity-dominant
Action-Priority bands); `li-v1` is a lightweight 3×3 likelihood×impact profile.

## Knowledge catalogs

Six packaged packs, all original clean-room text. Four are enabled by default:
`iso25010` quality aspects, `techniques`, `heuristics` (including consistency
oracles), and `guidewords` (element × guideword elicitation sets). Two are
opt-in for security-heavy products (add them to `config.catalogs`):
`mitre-attack` (adversary-tactic sweep, ATT&CK tactic names as facts, with the
MITRE attribution notice) and `owasp-web` (the ten web risk categories).
Entries are stable, citable ids (`techniques.stress-testing`) used by register
provenance fields. `risqlet catalog licenses` lists every loaded pack's license,
attribution, and any required notice. User packs in `.risqlet/catalogs/` load the
same way and may shadow packaged ones — including licensed decks you own (we
never distribute those).

| Pack | Default | License |
|---|---|---|
| iso25010, techniques, heuristics, guidewords | on | CC BY 4.0 |
| owasp-web | opt-in | CC BY 4.0 (category names per OWASP taxonomy) |
| mitre-attack | opt-in | MITRE ATT&CK terms (royalty-free, attribution required) |

## Agent skills

Two portable playbooks (cross-vendor Agent Skills format) ship in `skills/`:

- **risk-analysis** — the full six-phase facilitation: context grounding,
  aspect selection (max 6), multi-pass elicitation, rubric-anchored scoring,
  mitigation mapping, strategy export — with human gates recorded in the
  register's event log.
- **risk-quickscan** — a diff/PR-scoped single-pass scan that adds `proposed`
  risks and recommends a full session when warranted.
- **risk-court** — a targeted adversarial review of one high-stakes decision: the
  host convenes an independent panel to challenge it against the actual code, and
  `risqlet review` computes a deterministic SHIP/REMAND/BLOCK verdict from their
  charges (a category counts only when ≥2 distinct reviewers corroborate it). The
  verdict is *advisory* — recorded to `.risqlet/reviews.jsonl`, re-checked by
  `validate`, but never transitioning a risk; a human still decides. The host runs
  the reviewers; risqlet does the arithmetic and calls no model. Scope: an
  accept/sign-off/phase gate, not every `proposed` risk. Small evidence base so far —
  the mechanism is shipped, not a claim of universal accuracy.

Install them where your agent looks:

```bash
uv run risqlet skills install                          # ./.claude/skills (Claude Code project)
uv run risqlet skills install --target claude-user     # ~/.claude/skills
uv run risqlet skills install --target /path/to/dir    # opencode, kilo, Copilot, pi, ...
```

The skills drive the `risqlet` CLI, so any agent that can run shell commands can
follow them; a skipped human gate simply leaves a register that fails
`risqlet validate`.

## MCP server

For MCP-connected clients without repo shell access (Claude Desktop,
restricted setups), `risqlet mcp` runs a stateless stdio server exposing nine
tools over the same core — validation, scoring, exports, catalog browsing,
the playbooks as `get_guidance` topics, and gate-preserving register writes
(risks enter as `proposed`; decisions require a `human:` principal).

```bash
uv sync --extra mcp        # or: pip install 'risqlet[mcp]'
```

`.mcp.json` / Claude Desktop config:

```json
{
  "mcpServers": {
    "risqlet": {"command": "uv", "args": ["run", "risqlet", "mcp"]}
  }
}
```

Rule of thumb: coding agents with shell access get the best experience from
the CLI + skills; use MCP when the client cannot run shell commands.

## Platform support

Linux, macOS, and Windows. Each is exercised on every push by the test matrix
([`.github/workflows/test.yml`](.github/workflows/test.yml)), which runs the full
suite plus a clean install of the built wheel and `risqlet setup` for every agent
adapter — so what is claimed here is what CI actually runs.

| Component | Linux | macOS | Windows |
|---|---|---|---|
| CLI, register, `validate` / `score` / `export` | ✅ | ✅ | ✅ |
| `diff` / `check` and the CI gate | ✅ | ✅ | ✅ |
| `setup` (agent skills, MCP, instructions, commands) | ✅ | ✅ | ✅ |
| The `setup` check hook | ✅ | ✅ | ✅ |
| `guardrails` (shell hook templates) | ✅ | ✅ | ❌ |

`risqlet guardrails` is POSIX-only: its hook templates are shell one-liners and its
verifier uses POSIX process handling. On Windows it reports the guardrail as
unsupported rather than installing a hook that would not work. Everything else,
including the `setup` check hook, is shell-free and runs the same everywhere.

## Honest limits

The human-principal gate is a *convention enforced by validation*, not authentication:
an agent could write a `human:` event. On Claude Code, hooks add real enforcement;
elsewhere, the audit trail plus code review is the control. Scores are ordinal
heuristics for sorting attention, never measurements of "true" risk.

`guardrails` on Windows is a real gap, not a design stance — closing it means moving
each guardrail's logic out of its shell template and into the CLI, the way the check
hook already works.

## Project

- [CONTRIBUTING.md](CONTRIBUTING.md) — dev setup and the clean-room affirmation
- [SECURITY.md](SECURITY.md) — reporting vulnerabilities
- [CHANGELOG.md](CHANGELOG.md) · [RELEASING.md](RELEASING.md) · [docs/release-checklist.md](docs/release-checklist.md)

## License

Code: Apache-2.0 (`LICENSE`). Catalog pack content (`src/risqlet/catalog/packs/`): CC BY 4.0 (`LICENSE-CATALOG`), authored under the clean-room protocol in `CLEAN-ROOM.md` — original text expressing established concepts, originators credited per entry.
