pi-usereq 0.59.0 → 0.60.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# PI-useReq/pi-usereq (0.
|
|
1
|
+
# PI-useReq/pi-usereq (0.60.0)
|
|
2
2
|
|
|
3
3
|
<p align="center">
|
|
4
4
|
<img src="https://img.shields.io/badge/python-3.11%2B-3776AB?style=flat-square&logo=python&logoColor=white" alt="Python 3.11+">
|
|
@@ -51,7 +51,7 @@ in sync with the repository. All capabilities are exposed as slash commands and
|
|
|
51
51
|
- **Git repository** - every `req-*` command runs slash-command-owned git validation: the project must be inside a git work tree, the tracked working tree must be clean, and `HEAD` must resolve (a detached `HEAD` is tolerated; a working branch is recommended because the branch name is embedded in generated worktree names).
|
|
52
52
|
- **Requirements documentation** - the configured `docs-dir` (default `pi-usereq/docs`) must contain the canonical documents required by each command (`REQUIREMENTS.md`, `WORKFLOW.md`, `REFERENCES.md`); commands such as `/req-write`, `/req-create`, and `/req-workflow` are the entry points that generate them.
|
|
53
53
|
- **Static code checkers** - the bundled checkers (`pyright`, `ruff`, `eslint`) install automatically through the `postinstall` script; the native C/C++ checkers (`cppcheck`, `clang-format`) require a one-line system install (see [Install](#install)). Default configured languages: C, C++, JavaScript, Python, TypeScript.
|
|
54
|
-
- **Models** - model selection and model configuration are managed by the pi client, not by pi-usereq: the extension bundles no model files and exposes no model-related configuration or management surface (custom providers and models are configured in the pi client, e.g. `~/.pi/agent/models.json`, and selected through its model picker).
|
|
54
|
+
- **Models** - model selection and model configuration are managed by the pi client, not by pi-usereq: the extension bundles no model files and exposes no model-related configuration or management surface (custom providers and models are configured in the pi client, e.g. `~/.pi/agent/models.json`, and selected through its model picker). The tool is tested with the OpenRouter model `~deepseek/deepseek-v4-flash-latest`; the extension is model-agnostic and also works with other models exposed by the pi client.
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
## Feature Highlights
|
|
@@ -79,6 +79,12 @@ creating a worktree.
|
|
|
79
79
|
> session with a clean context (run `/new`, pi's `Start a new session` action) before each new `/req-*` command, unless you
|
|
80
80
|
> actually need to keep the previous context (for example when the next command builds on the outputs of the previous one).
|
|
81
81
|
|
|
82
|
+
> **Recommended context for analysis** — for the most effective analysis it is recommended to place the requirements,
|
|
83
|
+
> reference, and workflow documents in the prompt context by enabling the `Context Files` toggles for `REQUIREMENTS.md`,
|
|
84
|
+
> `REFERENCES.md`, and `WORKFLOW.md` (the settings-menu row then reads `Context Files requirements:on • references:on • workflow:on`).
|
|
85
|
+
> The enabled canonical documents are injected into every bundled prompt through `%%CONTEXT_FILES%%`, so the agent analyzes
|
|
86
|
+
> the requirements, the reference index, and the workflow documentation together with the source code.
|
|
87
|
+
|
|
82
88
|
| Command | Description | Required docs |
|
|
83
89
|
| --- | --- | --- |
|
|
84
90
|
| `/req-write` | Produce a *SRS* draft based on the User Request description | none |
|
|
@@ -275,7 +281,7 @@ The interactive configuration menu exposes every user-facing setting; changes ar
|
|
|
275
281
|
- **Documentation directory** — `docs-dir` (default `pi-usereq/docs`) used for the canonical documents.
|
|
276
282
|
- **Unit tests directory** — `tests-dir` (default `tests`).
|
|
277
283
|
- **Source directories** — `src-dir` (default `["src"]`) used by the analysis tools.
|
|
278
|
-
- **Context Files** — toggles to inject `REQUIREMENTS.md`, `WORKFLOW.md`, and `REFERENCES.md` into the prompt context through `%%CONTEXT_FILES%%`.
|
|
284
|
+
- **Context Files** — toggles to inject `REQUIREMENTS.md`, `WORKFLOW.md`, and `REFERENCES.md` into the prompt context through `%%CONTEXT_FILES%%`. It is recommended to keep all three toggles enabled (`requirements:on • references:on • workflow:on`) so the analysis commands receive the canonical documents in their context.
|
|
279
285
|
- **Auto git commit** — `enable` (default) injects git commit instructions into every prompt; `disable` forces read-only git behavior (`git_read-only.md`) and turns worktree orchestration off.
|
|
280
286
|
- **Git worktree** / **Worktree prefix** — enable/disable prompt-command worktree isolation and set the name prefix (default `PI-useReq-`).
|
|
281
287
|
- **Language static code checkers** — per-language `enable`/`disable` flags and the global `Command`-module checker definitions (view/remove/reset with confirmation).
|