@yahyahammad/venastine 0.1.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/.env.example +14 -0
- package/LICENSE +201 -0
- package/NOTICE +14 -0
- package/PRIVACY.md +66 -0
- package/README.md +878 -0
- package/SECURITY.md +88 -0
- package/THIRD_PARTY_NOTICES.md +100 -0
- package/agents/builtin/compactor.md +75 -0
- package/agents/builtin/explore.md +77 -0
- package/agents/builtin/grill-me.md +27 -0
- package/agents/builtin/initializer.md +94 -0
- package/agents/builtin/pipeline-reviewer.md +100 -0
- package/agents/builtin/plan.md +88 -0
- package/agents/builtin/review.md +74 -0
- package/agents/manager.py +195 -0
- package/agents/subagent_tool.py +215 -0
- package/agents/tui_commands.py +136 -0
- package/bin/venastine.mjs +382 -0
- package/config.py +1198 -0
- package/core/__init__.py +0 -0
- package/core/approval.py +115 -0
- package/core/client.py +1548 -0
- package/core/compaction.py +959 -0
- package/core/config_loader.py +1563 -0
- package/core/events.py +61 -0
- package/core/interaction.py +328 -0
- package/core/loop.py +1353 -0
- package/core/memory.py +370 -0
- package/core/model_windows.py +175 -0
- package/core/pipeline_models.py +176 -0
- package/core/reasoning/__init__.py +0 -0
- package/core/reasoning/authorization.py +130 -0
- package/core/reasoning/base.py +219 -0
- package/core/reasoning/confidence_scoring.py +468 -0
- package/core/reasoning/events.py +149 -0
- package/core/reasoning/json_retry.py +219 -0
- package/core/reasoning/orchestrator.py +1382 -0
- package/core/reasoning/output_writer.py +286 -0
- package/core/reasoning/payload_validation.py +398 -0
- package/core/reasoning/pipeline_storage.py +361 -0
- package/core/reasoning/review.py +615 -0
- package/core/reasoning/scholar.py +434 -0
- package/core/reasoning/source_corpus.py +327 -0
- package/core/reasoning/source_scoring.py +855 -0
- package/core/replay.py +167 -0
- package/core/session.py +153 -0
- package/core/workspace_trust.py +207 -0
- package/credentials.py +180 -0
- package/database.py +252 -0
- package/env_secrets.py +77 -0
- package/json_store.py +123 -0
- package/logging_setup.py +185 -0
- package/main.py +1959 -0
- package/mcp_client/__init__.py +15 -0
- package/mcp_client/client.py +499 -0
- package/mcp_client/config.py +379 -0
- package/mcp_client/registration.py +182 -0
- package/memories/manager.py +132 -0
- package/memories/tui_commands.py +232 -0
- package/package.json +73 -0
- package/project_init/config_files.py +278 -0
- package/project_init/doc_sets.py +330 -0
- package/project_init/generator.py +564 -0
- package/project_init/manifest.py +406 -0
- package/project_init/tui_commands.py +144 -0
- package/prompts/__init__.py +0 -0
- package/prompts/annotate.md +14 -0
- package/prompts/assumption_audit.md +27 -0
- package/prompts/claim_extraction.md +34 -0
- package/prompts/completeness.md +18 -0
- package/prompts/confidence_tiers.md +23 -0
- package/prompts/critic_pass.md +24 -0
- package/prompts/final_synthesis.md +13 -0
- package/prompts/initial_generation.md +14 -0
- package/prompts/preliminary_plan.md +23 -0
- package/prompts/revalidate.md +25 -0
- package/prompts/revise.md +15 -0
- package/prompts/source_grounding.md +66 -0
- package/prompts/system_prompts.py +262 -0
- package/prompts/universal_system_prompt +7 -0
- package/prompts/untrusted_content +1 -0
- package/providers.json.example +92 -0
- package/pyproject.toml +100 -0
- package/requirements.txt +72 -0
- package/safety/__init__.py +0 -0
- package/safety/policy_enforcement.py +682 -0
- package/security/__init__.py +0 -0
- package/security/capability.py +177 -0
- package/security/permissions.py +190 -0
- package/security/posture.py +302 -0
- package/security/protected_paths.py +309 -0
- package/security/sandbox.py +985 -0
- package/skills/builtin/crypto/cryptography-verification.md +66 -0
- package/skills/builtin/math/formal-specification.md +67 -0
- package/skills/builtin/math/numerical-methods.md +66 -0
- package/skills/builtin/math/proof-writing.md +61 -0
- package/skills/builtin/research/experiment-design.md +62 -0
- package/skills/builtin/research/literature-review.md +65 -0
- package/skills/builtin/research/reproducibility.md +55 -0
- package/skills/builtin/research/source-evaluation.md +70 -0
- package/skills/builtin/research/statistical-inference.md +63 -0
- package/skills/builtin/research/technical-writing.md +59 -0
- package/skills/builtin/security/cybersecurity-research.md +63 -0
- package/skills/builtin/software/code-review.md +61 -0
- package/skills/builtin/software/debugging.md +61 -0
- package/skills/builtin/software/test-design.md +67 -0
- package/skills/manager.py +138 -0
- package/skills/tui_commands.py +111 -0
- package/storage.py +1005 -0
- package/tools/base.py +305 -0
- package/tools/builtin/__init__.py +0 -0
- package/tools/builtin/_math_common.py +377 -0
- package/tools/builtin/_net_common.py +61 -0
- package/tools/builtin/arxiv.py +223 -0
- package/tools/builtin/ask_user.py +213 -0
- package/tools/builtin/discrete_math.py +134 -0
- package/tools/builtin/fetch_url.py +153 -0
- package/tools/builtin/file_ops.py +412 -0
- package/tools/builtin/geometry.py +148 -0
- package/tools/builtin/get_time.py +20 -0
- package/tools/builtin/linear_algebra.py +155 -0
- package/tools/builtin/load_skill.py +66 -0
- package/tools/builtin/logic.py +96 -0
- package/tools/builtin/pin.py +193 -0
- package/tools/builtin/probability_stats.py +228 -0
- package/tools/builtin/project_docs.py +405 -0
- package/tools/builtin/remember.py +158 -0
- package/tools/builtin/shell.py +461 -0
- package/tools/builtin/symbolic_math.py +119 -0
- package/tools/builtin/todo.py +147 -0
- package/tools/builtin/web_search.py +151 -0
- package/tools/context.py +136 -0
- package/tools/isolation.py +314 -0
- package/tools/registry.py +897 -0
- package/tui/app.py +3423 -0
- package/tui/app.tcss +458 -0
- package/tui/commands.py +61 -0
- package/tui/diffs.py +265 -0
- package/tui/preferences.py +182 -0
- package/tui/ravens.py +146 -0
- package/tui/screens.py +943 -0
- package/tui/themes.py +366 -0
- package/tui/widgets.py +1239 -0
package/.env.example
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Misc API keys for individual TOOLS -- NOT LLM provider keys.
|
|
2
|
+
#
|
|
3
|
+
# LLM provider credentials (OpenAI, Anthropic, etc.) live in providers.json,
|
|
4
|
+
# managed by credentials.py -- they are NOT read from here. This file is
|
|
5
|
+
# exclusively for one-off secrets that a specific tool needs to call some
|
|
6
|
+
# third-party grounding/research service.
|
|
7
|
+
#
|
|
8
|
+
# Copy this file to .env and fill in only the keys your registered tools
|
|
9
|
+
# actually need. Leave the rest blank -- env_secrets.get_env_secret() will
|
|
10
|
+
# raise a clear error at the point of use if a tool needs a key you never
|
|
11
|
+
# set, rather than failing silently with an empty string.
|
|
12
|
+
|
|
13
|
+
GITHUB_API_TOKEN=
|
|
14
|
+
NVD_API_KEY=
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Yahya Hammad
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
Venastine Research Harness
|
|
2
|
+
Copyright 2026 Yahya Hammad
|
|
3
|
+
|
|
4
|
+
This product includes software developed by
|
|
5
|
+
Yahya Hammad (https://github.com/YahyaHammad/Venastine-Research-Harness).
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0.
|
|
8
|
+
You may obtain a copy of the License at
|
|
9
|
+
|
|
10
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
|
|
12
|
+
This project does not redistribute its dependencies; they are resolved from
|
|
13
|
+
PyPI at install time under their own licenses. See THIRD_PARTY_NOTICES.md for
|
|
14
|
+
the license assessment of each declared dependency.
|
package/PRIVACY.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Privacy — Venastine Research Harness
|
|
2
|
+
|
|
3
|
+
**No telemetry. No analytics. No tracking.**
|
|
4
|
+
|
|
5
|
+
This harness runs entirely on your machine, from a checkout or from an npm install. It does not phone home, does not collect usage data, and has no hosted backend.
|
|
6
|
+
|
|
7
|
+
## What is stored locally
|
|
8
|
+
|
|
9
|
+
State lives in files, in one of two places depending on how you installed it — and in whatever paths you configure via environment variables, which override both:
|
|
10
|
+
|
|
11
|
+
* **From a clone**, everything is relative to the directory you run in, as the table below describes.
|
|
12
|
+
* **From npm**, the launcher points `app.db` and the log at `~/.config/venastine/` instead, so threads and memories follow you between directories rather than each folder keeping a separate silo. Research artifacts still land in `./output` beside the work that produced them, and an existing `./app.db` in the current directory always wins. `venastine --venastine-doctor` prints the resolved path for every row below.
|
|
13
|
+
|
|
14
|
+
| File / directory | What it holds | Created when |
|
|
15
|
+
|---|---|---|
|
|
16
|
+
| `app.db` (`APP_DB_PATH`) — `~/.config/venastine/app.db` on an npm install | SQLite: `MessageLog`, `ConversationThread`, `CompactionCheckpoint`, `ThreadSummary`, `UserMemory` (`storage.py`) and `PipelineRunRecord` (`core/reasoning/pipeline_storage.py`) — every chat turn, every research pass, and any `remember` memories | First run creates it |
|
|
17
|
+
| `logs/app.log` (`AGENT_LOG_FILE`, 1 MB × 3 rotated) — under `~/.config/venastine/logs/` on an npm install | **INFO and above** by default (`AGENT_LOG_LEVEL` overrides), including provider/HTTP traces. Redacted via `safety/policy_enforcement.redact_secrets` (same patterns as tool output) but may still contain query text | Every run appends |
|
|
18
|
+
| `output/<run_id>/` (`AGENT_OUTPUT_DIR`) | Per-run artifacts: `report.md`, `report.pdf` (if `weasyprint`), `00_plan.md` … `07_review.json`, `trace.md` | Every ` --mode research` run |
|
|
19
|
+
| `output/<run_id>/sources/` | **Since §45: the text of every page a run retrieved**, one `<sha256>.txt` per document, plus an `index.json` of urls, tools, timestamps, hashes and lengths. This is what makes a similarity score checkable rather than something you take on trust. Everything written here has been through the same redaction tool output gets. Set `PERSIST_SOURCE_TEXT = False` in `config.py` to keep the index and drop the text | Every research run that fetched anything |
|
|
20
|
+
| `~/.config/venastine/pipeline_models.json` | The `/critic` and `/embedder` model choices — provider and model name only, no keys | You run either command |
|
|
21
|
+
| `providers.json` (`AGENT_PROVIDERS_FILE`) & `.env` (`AGENT_ENV_FILE`) | Your local secrets (LLM provider keys + tool API keys). Gitignored, `export-ignore`d, and excluded from the npm tarball by the `files` allowlist; never sent except as described below | You create via `cp *.example` |
|
|
22
|
+
| `~/.config/venastine/providers.json` | Optional user-level provider keys. An npm install reads this **only** when the current directory has no `providers.json` of its own — a local one always wins | You create it, for a command you run from anywhere |
|
|
23
|
+
| `~/.config/venastine/runtime/<version>-<hash>/` | The Python virtual environment an npm install builds on first run, after asking. Holds the pinned dependencies, no data of yours | First `venastine` run, with your consent |
|
|
24
|
+
| `~/.config/venastine/settings.json` & `~/.config/venastine/mcp.json` | Your user-tier settings/MCP servers | On first trust / settings save |
|
|
25
|
+
| `~/.config/venastine/trusted_projects.json` | Workspace trust store (path + content hash) | After you answer the trust prompt |
|
|
26
|
+
| `<project>/.venastine/` | Project-tier config — `settings.json`, `mcp.json`, plus any project `agents/` and `skills/`. Loaded only after you trust the workspace (`core/workspace_trust.py`) | You create it, or `/init` does |
|
|
27
|
+
| `<project>/AGENTS.md` | The project's hub document, injected into the system prompt of any agent that opts in. An ordinary committed file, but it is inside the same trust boundary as `.venastine/` and a change to it re-triggers the trust prompt | You write it, or `/init` does |
|
|
28
|
+
|
|
29
|
+
Everything above is **local-only** by default, and three separate mechanisms keep it out of the three ways this project is distributed: `.gitignore` for `git push`, `.gitattributes` `export-ignore` for `git archive` and "Download ZIP", and the `files` allowlist in `package.json` for the npm tarball. `app.db`, `logs/`, `output/`, `providers.json` and `.env` are excluded by all three.
|
|
30
|
+
|
|
31
|
+
## What leaves your machine
|
|
32
|
+
|
|
33
|
+
Only explicit external calls you configured or the model chose:
|
|
34
|
+
|
|
35
|
+
* **LLM provider** — the prompt + tool results are sent to the provider named in `providers.json` (e.g. `ANTHROPIC`, `OPENAI`, your OpenAI-compatible endpoint at `API_URL`). No other party sees them from this harness.
|
|
36
|
+
* **Tool fetches** — `web_search` (via `ddgs` → DuckDuckGo/Brave/etc.), `fetch_url` (direct HTTP GET), `arxiv_search`, and any **MCP server** you listed in `mcp.json` (stdio `command` or http `url`/`headers`). Each is a real HTTP/process call; the target site/server sees the request.
|
|
37
|
+
* **Embedder** — if you set one with `/embedder`, each claim's text and windows of the pages a run fetched are sent to that provider to be turned into vectors. It is a second provider seeing your research content, which is why choosing it is a command rather than a `settings.json` key a cloned repository could set. With no embedder configured, nothing is sent and every run says so in its trace.
|
|
38
|
+
* **OpenAlex** (`api.openalex.org`) — **off by default**. When `SCHOLAR_LOOKUP` is on, the DOI or arXiv id of each cited paper is looked up to score its venue, citation standing and authors. What leaves is the identifier and the shape of the cohort query — never your claim text, never your query. No contact address is sent unless you set `SCHOLAR_MAILTO` yourself; the harness never derives one from your git config or environment. This is the one call made outside the tool layer, so it does not appear in `granted_calls.json`.
|
|
39
|
+
* Nothing else. There is no crash reporter, no update check, no hosted proxy.
|
|
40
|
+
|
|
41
|
+
Fetched content is subject to its origin's terms (including `robots.txt` / ToS). See the grounding note in `README.md` — do not republish `report.md`/`report.pdf` with large verbatim excerpts without rights.
|
|
42
|
+
|
|
43
|
+
## Retention and deletion
|
|
44
|
+
|
|
45
|
+
No automatic expiry — a thread lives until you delete it.
|
|
46
|
+
|
|
47
|
+
* **Wipe everything (clone):** `rm app.db` + `rm -rf output/` + `rm logs/app.log*` — next run recreates an empty DB.
|
|
48
|
+
On Windows PowerShell: `Remove-Item app.db, logs/app.log* ; Remove-Item -Recurse -Force output/`
|
|
49
|
+
* **Wipe everything (npm install):** `rm -rf ~/.config/venastine/app.db ~/.config/venastine/logs/` plus any `output/` directories in the folders you worked in.
|
|
50
|
+
On Windows PowerShell: `Remove-Item -Recurse -Force "$HOME/.config/venastine/app.db", "$HOME/.config/venastine/logs"`
|
|
51
|
+
To remove the Python environment as well: `venastine --venastine-reinstall` deletes it, or `rm -rf ~/.config/venastine/runtime/`. Uninstalling the package (`npm rm -g @yahyahammad/venastine`) does **not** remove anything under `~/.config/venastine/` — that is your data and config, and it is left for you to delete.
|
|
52
|
+
* **One thread:** there is no single-thread delete command; wiping the DB is the intended granularity (threads are cheap and local).
|
|
53
|
+
* **Durable memories:** `python main.py --memories` to list, `python main.py --forget <id>` to delete one by id (never by substring, by design).
|
|
54
|
+
* **Settings/trust:** delete `~/.config/venastine/settings.json` or `trusted_projects.json` entries directly. The same folder holds `ui_preferences.json`, `model_windows.json` and `pipeline_models.json` — remembered UI and model choices, no keys and no content.
|
|
55
|
+
* **Fetched page text only:** `rm -rf output/*/sources/` removes the retrieved text while leaving each run's report, claims and scores in place. The scores stay, but nothing can re-derive them afterwards.
|
|
56
|
+
|
|
57
|
+
## If you publish a report
|
|
58
|
+
|
|
59
|
+
`output/<run_id>/report.md` may quote third-party pages. Before publishing, verify you have the right to share those excerpts (fair-use / citation) and redact any private data that entered via a tool result or a prompted memory.
|
|
60
|
+
|
|
61
|
+
## Questions
|
|
62
|
+
|
|
63
|
+
Open an issue at https://github.com/YahyaHammad/Venastine-Research-Harness/issues.
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
*This project is self-hosted. There is no data controller beyond you. If you fork and add hosted telemetry, you become responsible for disclosing it.*
|