jevcompass 0.1.14__tar.gz
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.
- jevcompass-0.1.14/LICENSE +202 -0
- jevcompass-0.1.14/MANIFEST.in +2 -0
- jevcompass-0.1.14/PKG-INFO +145 -0
- jevcompass-0.1.14/README.md +121 -0
- jevcompass-0.1.14/pyproject.toml +43 -0
- jevcompass-0.1.14/setup.cfg +4 -0
- jevcompass-0.1.14/src/jevcompass/__init__.py +3 -0
- jevcompass-0.1.14/src/jevcompass/__main__.py +10 -0
- jevcompass-0.1.14/src/jevcompass/advisor.py +447 -0
- jevcompass-0.1.14/src/jevcompass/catalog.py +268 -0
- jevcompass-0.1.14/src/jevcompass/catalog_data.json +26 -0
- jevcompass-0.1.14/src/jevcompass/cli.py +344 -0
- jevcompass-0.1.14/src/jevcompass/credentials.py +215 -0
- jevcompass-0.1.14/src/jevcompass/decisions.py +94 -0
- jevcompass-0.1.14/src/jevcompass/installer.py +166 -0
- jevcompass-0.1.14/src/jevcompass/paths.py +12 -0
- jevcompass-0.1.14/src/jevcompass.egg-info/PKG-INFO +145 -0
- jevcompass-0.1.14/src/jevcompass.egg-info/SOURCES.txt +20 -0
- jevcompass-0.1.14/src/jevcompass.egg-info/dependency_links.txt +1 -0
- jevcompass-0.1.14/src/jevcompass.egg-info/entry_points.txt +2 -0
- jevcompass-0.1.14/src/jevcompass.egg-info/requires.txt +3 -0
- jevcompass-0.1.14/src/jevcompass.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: jevcompass
|
|
3
|
+
Version: 0.1.14
|
|
4
|
+
Summary: Privacy-first tool and skill recommendations for Codex Desktop and CLI, powered by Jev
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Project-URL: Homepage, https://github.com/acidkill/JevCompass
|
|
7
|
+
Project-URL: Repository, https://github.com/acidkill/JevCompass
|
|
8
|
+
Project-URL: Issues, https://github.com/acidkill/JevCompass/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/acidkill/JevCompass/blob/main/RELEASE_NOTES.md
|
|
10
|
+
Keywords: codex,codex-cli,ai-agents,agent-skills,mcp,tool-selection,developer-tools,jev
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
13
|
+
Classifier: Operating System :: MacOS :: MacOS X
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Topic :: Software Development
|
|
17
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
18
|
+
Requires-Python: >=3.11
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Provides-Extra: secure-store
|
|
22
|
+
Requires-Dist: keyring>=25; extra == "secure-store"
|
|
23
|
+
Dynamic: license-file
|
|
24
|
+
|
|
25
|
+
# JevCompass
|
|
26
|
+
|
|
27
|
+

|
|
28
|
+
|
|
29
|
+
**Give Codex a map of the tools and skills it already has.**
|
|
30
|
+
|
|
31
|
+
A useful skill can be buried in your setup. JevCompass discovers installed candidates locally, narrows them with a reviewed catalog, and offers a short suggestion when a task has a clear match. It works with Codex Desktop and CLI hooks, without replacing your agent or gating everyday commands.
|
|
32
|
+
|
|
33
|
+
- **Start fast:** try explicit advice from the terminal before installing any hooks.
|
|
34
|
+
- **Keep control:** suggestions never run tools, grant permissions, or override required checks.
|
|
35
|
+
- **Choose your privacy level:** local advice works without a key; optional Jev ranking sees only coarse candidate metadata through OpenRouter.
|
|
36
|
+
|
|
37
|
+
[Get started](#quick-start) · [See real output](#60-second-demo) · [Understand the boundary](#privacy) · [Check the evidence](#what-has-been-verified) · [Contribute](#contribute)
|
|
38
|
+
|
|
39
|
+
## Quick start
|
|
40
|
+
|
|
41
|
+
Requirements: Python 3.11 or newer, [pipx](https://pipx.pypa.io/stable/installation/), and a Codex installation with hooks enabled. Download the v0.1.14 wheel from the [GitHub release](https://github.com/acidkill/JevCompass/releases/tag/v0.1.14), verify its SHA-256 against the release asset digest, then run:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
pipx install ./jevcompass-0.1.14-py3-none-any.whl
|
|
45
|
+
jevcompass recommend --category review --domain python
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
To install from source instead, clone this repository and run `pipx install .` from the checkout. JevCompass is not yet on PyPI.
|
|
49
|
+
|
|
50
|
+
The recommendation is environment-dependent: it can show local advice, an unranked shortlist, or no recommendation. The manual command uses explicit category/domain metadata and never takes a task prompt.
|
|
51
|
+
|
|
52
|
+
To enable automatic advice, first inspect what would change, then install:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
jevcompass install --dry-run
|
|
56
|
+
jevcompass install
|
|
57
|
+
jevcompass doctor
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**What changes:** `jevcompass install` backs up an existing Codex `hooks.json` and registers two advisory hooks. Review and trust the registrations in Codex's `/hooks` screen, then start a fresh session. The default config is under `~/.codex`; set `CODEX_HOME` to use a different Codex home. A successful `doctor` check confirms local registration, not that Codex loaded or delivered advice.
|
|
61
|
+
|
|
62
|
+
## Verify advice in a fresh session
|
|
63
|
+
|
|
64
|
+
After `jevcompass install`, inspect the two registrations in Codex `/hooks`, trust them if prompted, and start a **new** Desktop or CLI session. For a focused check, give Codex a substantive task such as planning a small Python package and ask it to report any `JevCompass advice ID` and suggested IDs from its initial context **before its first tool call**. An absent ID means that session did not receive advice; `doctor` and local hook metrics alone cannot prove delivery. The advisor may intentionally stay silent when only a generic shell command is available.
|
|
65
|
+
|
|
66
|
+
If your Codex host does not load either hook, run `jevcompass doctor --json` to distinguish registration from recent invocation, and use the explicit `jevcompass recommend --category project-setup --domain python` command while investigating. Never treat a manual result as proof that a hook delivered context to an agent.
|
|
67
|
+
|
|
68
|
+
## 60-second demo
|
|
69
|
+
|
|
70
|
+
After the quick start, ask about setting up a Python project:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
jevcompass recommend --category project-setup --domain python
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
For example, on a Linux checkout with `OPENROUTER_API_KEY` unset, the CLI returned this local shortlist (excerpt):
|
|
77
|
+
|
|
78
|
+
```text
|
|
79
|
+
Local unranked fallback; Jev did not select these candidates.
|
|
80
|
+
- tool `exec_command`: Codex built-in exec_command for bounded local shell commands
|
|
81
|
+
- local command `git`: Inspect repository changes and history
|
|
82
|
+
- skill `create-plan`: Create an implementation plan grounded in repository context
|
|
83
|
+
- skill `python-packaging`: Build and distribute a Python package
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Your shortlist depends on the tools and skills actually installed. An unranked fallback is not a Jev choice. `jevcompass install --dry-run` previews the two hook registrations without writing them; after installation, trust them in Codex `/hooks` and start a fresh session. With an OpenRouter key, an eligible task can ask Jev to rank safe metadata and may incur provider charges. [Evidence and current limits](#what-has-been-verified) distinguish hook delivery from measured benefit.
|
|
87
|
+
|
|
88
|
+
## How it works
|
|
89
|
+
|
|
90
|
+
- **Prompt hook:** `UserPromptSubmit` classifies an eligible prompt locally, then checks reviewed candidates discovered on the machine. Explicit Codex Desktop/CLI hook or skill setup can point to the installed `openai-docs` skill; routine prompts and unavailable skills can remain silent.
|
|
91
|
+
- **Subagent hook:** `SubagentStart` can suggest role-level candidates for Codex's built-in `explorer` and `worker` roles. That event does not include the subagent's task text.
|
|
92
|
+
- **Optional spawn advice:** `jevcompass install --spawn-advice` adds a narrowly matched `PreToolUse` hook for agent creation only (`Agent`, `spawn_agent`, or `collaborationspawn_agent`). It locally classifies readable child task text or a descriptive `task_name`, then sends only coarse metadata and reviewed candidate descriptions to Jev. It never gates a spawn, shell, Git, Helm, or network command. If neither field provides a clear category or no useful candidates exist, it stays silent. A normal reinstall preserves the opt-in; `jevcompass install --disable-spawn-advice` removes it. Review and trust the updated hook in `/hooks`, then start a fresh session. This is experimental and disabled by default; verify the child sees an advice ID before its first tool before relying on it.
|
|
93
|
+
- **Manual mode:** `jevcompass recommend --category CATEGORY --domain DOMAIN [--role ROLE]` requests advice using explicit metadata. Use `jevcompass recommend --help` for accepted values.
|
|
94
|
+
- **Uncertainty:** Local fallback advice is labeled unranked. If there is no useful candidate, JevCompass can stay silent. A configured MCP server is not assumed to be callable in the active session.
|
|
95
|
+
- **Control:** Advice does not run tools or skills, change permissions, block commands, or replace project instructions and required checks.
|
|
96
|
+
|
|
97
|
+
For setup diagnostics, run `jevcompass doctor`; use `jevcompass --version` to identify the installed command and `jevcompass doctor --json` for structured output. The optional `--test-jev` flag sends one synthetic, billed request.
|
|
98
|
+
|
|
99
|
+
## Privacy
|
|
100
|
+
|
|
101
|
+
Prompt classification and candidate discovery happen locally. When optional Jev ranking is used, JevCompass sends an allowlisted category, domain, role, criteria, and generic descriptions of reviewed candidates to OpenRouter's Decisions API. It does **not** send the raw prompt, source code, diffs, repository paths, memory contents, or private skill descriptions in that request. OpenRouter receives the API key in the HTTPS authorization header.
|
|
102
|
+
|
|
103
|
+
Local metrics contain event/category/outcome/timing and a short advice ID; they do not record the prompt, model response, paths, or memory content. Local cache entries contain selection metadata. As with any external service, review OpenRouter's terms and data handling before enabling remote ranking.
|
|
104
|
+
|
|
105
|
+
Remote ranking is optional. Without a key or a reliable Jev response, JevCompass can use a small local shortlist when useful; otherwise it can stay silent. Network errors and timeouts do not block the Codex task.
|
|
106
|
+
|
|
107
|
+
## Compatibility
|
|
108
|
+
|
|
109
|
+
- Python 3.11+
|
|
110
|
+
- Linux: local runtime and CLI checks have been performed.
|
|
111
|
+
- macOS: targeted, but runtime behavior has not been verified.
|
|
112
|
+
- Windows: not a verified target.
|
|
113
|
+
- Codex Desktop and CLI: the default installation registers `UserPromptSubmit` and `SubagentStart`; optional agent-spawn advice adds only a narrowly matched `PreToolUse` hook. Host delivery is version-, trust-, and session-dependent. Fresh Desktop prompt delivery and broad subagent coverage remain unverified.
|
|
114
|
+
|
|
115
|
+
JevCompass does not infer Codex Plan UI mode. Check `/hooks` and start a fresh session after installation or a Codex upgrade.
|
|
116
|
+
|
|
117
|
+
## What has been verified
|
|
118
|
+
|
|
119
|
+
Evidence is deliberately limited to the environments tested:
|
|
120
|
+
|
|
121
|
+
- A fresh isolated Codex CLI 0.155.1 smoke using the published v0.1.12 wheel received `openai-docs` advice before its first tool, with a matching local hook ID. Additional synthetic CLI pairs confirmed remote Jev advice IDs before the first tool. The published v0.1.13 wheel adds bounded skill use/skip conditions; these checks do not prove broad coverage or effectiveness.
|
|
122
|
+
- The initial four blinded synthetic CLI pairs tied on task quality. Later focused pairs had mixed results, including one baseline win and one treatment win; no repeatable speed or quality improvement has been demonstrated.
|
|
123
|
+
- One native Desktop `explorer` child reported an advice ID before its first tool in a correlated smoke test. Other subagent probes were inconclusive, and fresh Desktop prompt delivery has not been confirmed.
|
|
124
|
+
- The v0.1.14 source includes the changes from PR #40 (respect installed skill MCP prerequisites), PR #41 (C05 equal-environment comparison tied on blind scores), and PR #42 (opt-in agent-spawn advice). The spawn check was an isolated CLI source-checkout run: the child saw an advice ID before its first tool using the descriptive task title because the host message was encoded. This has not been verified in a published wheel, Desktop, or macOS, and no outcome benefit has been demonstrated. The default install remains two advisory hooks; routine commands are not gated.
|
|
125
|
+
- macOS runtime behavior and broad usefulness remain unverified.
|
|
126
|
+
|
|
127
|
+
These checks do not establish that recommendations improve outcomes. If you test JevCompass, please share a reproducible example of advice that helped—or a case where silence was the right result.
|
|
128
|
+
|
|
129
|
+
## Soon available
|
|
130
|
+
|
|
131
|
+
More host validation, narrower coding recommendations, and a measured 20-case comparison are tracked in the [roadmap](ROADMAP.md). These are planned work, not shipped capabilities or proven productivity gains.
|
|
132
|
+
|
|
133
|
+
## Contribute
|
|
134
|
+
|
|
135
|
+
Issues and pull requests are welcome. Helpful contributions include reproducible compatibility reports, careful documentation fixes, and synthetic tests that preserve the privacy boundary. Please do not post credentials, raw prompts, private code, or unredacted logs.
|
|
136
|
+
|
|
137
|
+
## License
|
|
138
|
+
|
|
139
|
+
JevCompass is licensed under the [Apache License 2.0](LICENSE). Copyright 2026 Toni Nowak.
|
|
140
|
+
|
|
141
|
+
## Project links
|
|
142
|
+
|
|
143
|
+
- [Open an issue](https://github.com/acidkill/JevCompass/issues)
|
|
144
|
+
- [Propose a change](https://github.com/acidkill/JevCompass/pulls)
|
|
145
|
+
- [Browse the source](https://github.com/acidkill/JevCompass)
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# JevCompass
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
**Give Codex a map of the tools and skills it already has.**
|
|
6
|
+
|
|
7
|
+
A useful skill can be buried in your setup. JevCompass discovers installed candidates locally, narrows them with a reviewed catalog, and offers a short suggestion when a task has a clear match. It works with Codex Desktop and CLI hooks, without replacing your agent or gating everyday commands.
|
|
8
|
+
|
|
9
|
+
- **Start fast:** try explicit advice from the terminal before installing any hooks.
|
|
10
|
+
- **Keep control:** suggestions never run tools, grant permissions, or override required checks.
|
|
11
|
+
- **Choose your privacy level:** local advice works without a key; optional Jev ranking sees only coarse candidate metadata through OpenRouter.
|
|
12
|
+
|
|
13
|
+
[Get started](#quick-start) · [See real output](#60-second-demo) · [Understand the boundary](#privacy) · [Check the evidence](#what-has-been-verified) · [Contribute](#contribute)
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
Requirements: Python 3.11 or newer, [pipx](https://pipx.pypa.io/stable/installation/), and a Codex installation with hooks enabled. Download the v0.1.14 wheel from the [GitHub release](https://github.com/acidkill/JevCompass/releases/tag/v0.1.14), verify its SHA-256 against the release asset digest, then run:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pipx install ./jevcompass-0.1.14-py3-none-any.whl
|
|
21
|
+
jevcompass recommend --category review --domain python
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
To install from source instead, clone this repository and run `pipx install .` from the checkout. JevCompass is not yet on PyPI.
|
|
25
|
+
|
|
26
|
+
The recommendation is environment-dependent: it can show local advice, an unranked shortlist, or no recommendation. The manual command uses explicit category/domain metadata and never takes a task prompt.
|
|
27
|
+
|
|
28
|
+
To enable automatic advice, first inspect what would change, then install:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
jevcompass install --dry-run
|
|
32
|
+
jevcompass install
|
|
33
|
+
jevcompass doctor
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**What changes:** `jevcompass install` backs up an existing Codex `hooks.json` and registers two advisory hooks. Review and trust the registrations in Codex's `/hooks` screen, then start a fresh session. The default config is under `~/.codex`; set `CODEX_HOME` to use a different Codex home. A successful `doctor` check confirms local registration, not that Codex loaded or delivered advice.
|
|
37
|
+
|
|
38
|
+
## Verify advice in a fresh session
|
|
39
|
+
|
|
40
|
+
After `jevcompass install`, inspect the two registrations in Codex `/hooks`, trust them if prompted, and start a **new** Desktop or CLI session. For a focused check, give Codex a substantive task such as planning a small Python package and ask it to report any `JevCompass advice ID` and suggested IDs from its initial context **before its first tool call**. An absent ID means that session did not receive advice; `doctor` and local hook metrics alone cannot prove delivery. The advisor may intentionally stay silent when only a generic shell command is available.
|
|
41
|
+
|
|
42
|
+
If your Codex host does not load either hook, run `jevcompass doctor --json` to distinguish registration from recent invocation, and use the explicit `jevcompass recommend --category project-setup --domain python` command while investigating. Never treat a manual result as proof that a hook delivered context to an agent.
|
|
43
|
+
|
|
44
|
+
## 60-second demo
|
|
45
|
+
|
|
46
|
+
After the quick start, ask about setting up a Python project:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
jevcompass recommend --category project-setup --domain python
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
For example, on a Linux checkout with `OPENROUTER_API_KEY` unset, the CLI returned this local shortlist (excerpt):
|
|
53
|
+
|
|
54
|
+
```text
|
|
55
|
+
Local unranked fallback; Jev did not select these candidates.
|
|
56
|
+
- tool `exec_command`: Codex built-in exec_command for bounded local shell commands
|
|
57
|
+
- local command `git`: Inspect repository changes and history
|
|
58
|
+
- skill `create-plan`: Create an implementation plan grounded in repository context
|
|
59
|
+
- skill `python-packaging`: Build and distribute a Python package
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Your shortlist depends on the tools and skills actually installed. An unranked fallback is not a Jev choice. `jevcompass install --dry-run` previews the two hook registrations without writing them; after installation, trust them in Codex `/hooks` and start a fresh session. With an OpenRouter key, an eligible task can ask Jev to rank safe metadata and may incur provider charges. [Evidence and current limits](#what-has-been-verified) distinguish hook delivery from measured benefit.
|
|
63
|
+
|
|
64
|
+
## How it works
|
|
65
|
+
|
|
66
|
+
- **Prompt hook:** `UserPromptSubmit` classifies an eligible prompt locally, then checks reviewed candidates discovered on the machine. Explicit Codex Desktop/CLI hook or skill setup can point to the installed `openai-docs` skill; routine prompts and unavailable skills can remain silent.
|
|
67
|
+
- **Subagent hook:** `SubagentStart` can suggest role-level candidates for Codex's built-in `explorer` and `worker` roles. That event does not include the subagent's task text.
|
|
68
|
+
- **Optional spawn advice:** `jevcompass install --spawn-advice` adds a narrowly matched `PreToolUse` hook for agent creation only (`Agent`, `spawn_agent`, or `collaborationspawn_agent`). It locally classifies readable child task text or a descriptive `task_name`, then sends only coarse metadata and reviewed candidate descriptions to Jev. It never gates a spawn, shell, Git, Helm, or network command. If neither field provides a clear category or no useful candidates exist, it stays silent. A normal reinstall preserves the opt-in; `jevcompass install --disable-spawn-advice` removes it. Review and trust the updated hook in `/hooks`, then start a fresh session. This is experimental and disabled by default; verify the child sees an advice ID before its first tool before relying on it.
|
|
69
|
+
- **Manual mode:** `jevcompass recommend --category CATEGORY --domain DOMAIN [--role ROLE]` requests advice using explicit metadata. Use `jevcompass recommend --help` for accepted values.
|
|
70
|
+
- **Uncertainty:** Local fallback advice is labeled unranked. If there is no useful candidate, JevCompass can stay silent. A configured MCP server is not assumed to be callable in the active session.
|
|
71
|
+
- **Control:** Advice does not run tools or skills, change permissions, block commands, or replace project instructions and required checks.
|
|
72
|
+
|
|
73
|
+
For setup diagnostics, run `jevcompass doctor`; use `jevcompass --version` to identify the installed command and `jevcompass doctor --json` for structured output. The optional `--test-jev` flag sends one synthetic, billed request.
|
|
74
|
+
|
|
75
|
+
## Privacy
|
|
76
|
+
|
|
77
|
+
Prompt classification and candidate discovery happen locally. When optional Jev ranking is used, JevCompass sends an allowlisted category, domain, role, criteria, and generic descriptions of reviewed candidates to OpenRouter's Decisions API. It does **not** send the raw prompt, source code, diffs, repository paths, memory contents, or private skill descriptions in that request. OpenRouter receives the API key in the HTTPS authorization header.
|
|
78
|
+
|
|
79
|
+
Local metrics contain event/category/outcome/timing and a short advice ID; they do not record the prompt, model response, paths, or memory content. Local cache entries contain selection metadata. As with any external service, review OpenRouter's terms and data handling before enabling remote ranking.
|
|
80
|
+
|
|
81
|
+
Remote ranking is optional. Without a key or a reliable Jev response, JevCompass can use a small local shortlist when useful; otherwise it can stay silent. Network errors and timeouts do not block the Codex task.
|
|
82
|
+
|
|
83
|
+
## Compatibility
|
|
84
|
+
|
|
85
|
+
- Python 3.11+
|
|
86
|
+
- Linux: local runtime and CLI checks have been performed.
|
|
87
|
+
- macOS: targeted, but runtime behavior has not been verified.
|
|
88
|
+
- Windows: not a verified target.
|
|
89
|
+
- Codex Desktop and CLI: the default installation registers `UserPromptSubmit` and `SubagentStart`; optional agent-spawn advice adds only a narrowly matched `PreToolUse` hook. Host delivery is version-, trust-, and session-dependent. Fresh Desktop prompt delivery and broad subagent coverage remain unverified.
|
|
90
|
+
|
|
91
|
+
JevCompass does not infer Codex Plan UI mode. Check `/hooks` and start a fresh session after installation or a Codex upgrade.
|
|
92
|
+
|
|
93
|
+
## What has been verified
|
|
94
|
+
|
|
95
|
+
Evidence is deliberately limited to the environments tested:
|
|
96
|
+
|
|
97
|
+
- A fresh isolated Codex CLI 0.155.1 smoke using the published v0.1.12 wheel received `openai-docs` advice before its first tool, with a matching local hook ID. Additional synthetic CLI pairs confirmed remote Jev advice IDs before the first tool. The published v0.1.13 wheel adds bounded skill use/skip conditions; these checks do not prove broad coverage or effectiveness.
|
|
98
|
+
- The initial four blinded synthetic CLI pairs tied on task quality. Later focused pairs had mixed results, including one baseline win and one treatment win; no repeatable speed or quality improvement has been demonstrated.
|
|
99
|
+
- One native Desktop `explorer` child reported an advice ID before its first tool in a correlated smoke test. Other subagent probes were inconclusive, and fresh Desktop prompt delivery has not been confirmed.
|
|
100
|
+
- The v0.1.14 source includes the changes from PR #40 (respect installed skill MCP prerequisites), PR #41 (C05 equal-environment comparison tied on blind scores), and PR #42 (opt-in agent-spawn advice). The spawn check was an isolated CLI source-checkout run: the child saw an advice ID before its first tool using the descriptive task title because the host message was encoded. This has not been verified in a published wheel, Desktop, or macOS, and no outcome benefit has been demonstrated. The default install remains two advisory hooks; routine commands are not gated.
|
|
101
|
+
- macOS runtime behavior and broad usefulness remain unverified.
|
|
102
|
+
|
|
103
|
+
These checks do not establish that recommendations improve outcomes. If you test JevCompass, please share a reproducible example of advice that helped—or a case where silence was the right result.
|
|
104
|
+
|
|
105
|
+
## Soon available
|
|
106
|
+
|
|
107
|
+
More host validation, narrower coding recommendations, and a measured 20-case comparison are tracked in the [roadmap](ROADMAP.md). These are planned work, not shipped capabilities or proven productivity gains.
|
|
108
|
+
|
|
109
|
+
## Contribute
|
|
110
|
+
|
|
111
|
+
Issues and pull requests are welcome. Helpful contributions include reproducible compatibility reports, careful documentation fixes, and synthetic tests that preserve the privacy boundary. Please do not post credentials, raw prompts, private code, or unredacted logs.
|
|
112
|
+
|
|
113
|
+
## License
|
|
114
|
+
|
|
115
|
+
JevCompass is licensed under the [Apache License 2.0](LICENSE). Copyright 2026 Toni Nowak.
|
|
116
|
+
|
|
117
|
+
## Project links
|
|
118
|
+
|
|
119
|
+
- [Open an issue](https://github.com/acidkill/JevCompass/issues)
|
|
120
|
+
- [Propose a change](https://github.com/acidkill/JevCompass/pulls)
|
|
121
|
+
- [Browse the source](https://github.com/acidkill/JevCompass)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77.0.3"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "jevcompass"
|
|
7
|
+
version = "0.1.14"
|
|
8
|
+
description = "Privacy-first tool and skill recommendations for Codex Desktop and CLI, powered by Jev"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
requires-python = ">=3.11"
|
|
13
|
+
keywords = ["codex", "codex-cli", "ai-agents", "agent-skills", "mcp", "tool-selection", "developer-tools", "jev"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Environment :: Console",
|
|
16
|
+
"Operating System :: POSIX :: Linux",
|
|
17
|
+
"Operating System :: MacOS :: MacOS X",
|
|
18
|
+
"Programming Language :: Python :: 3",
|
|
19
|
+
"Programming Language :: Python :: 3.11",
|
|
20
|
+
"Topic :: Software Development",
|
|
21
|
+
"Topic :: Software Development :: Libraries",
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[project.urls]
|
|
25
|
+
Homepage = "https://github.com/acidkill/JevCompass"
|
|
26
|
+
Repository = "https://github.com/acidkill/JevCompass"
|
|
27
|
+
Issues = "https://github.com/acidkill/JevCompass/issues"
|
|
28
|
+
Changelog = "https://github.com/acidkill/JevCompass/blob/main/RELEASE_NOTES.md"
|
|
29
|
+
|
|
30
|
+
[project.optional-dependencies]
|
|
31
|
+
secure-store = ["keyring>=25"]
|
|
32
|
+
|
|
33
|
+
[project.scripts]
|
|
34
|
+
jevcompass = "jevcompass.cli:main"
|
|
35
|
+
|
|
36
|
+
[tool.setuptools.packages.find]
|
|
37
|
+
where = ["src"]
|
|
38
|
+
|
|
39
|
+
[tool.setuptools.package-data]
|
|
40
|
+
jevcompass = ["catalog_data.json"]
|
|
41
|
+
|
|
42
|
+
[tool.pytest.ini_options]
|
|
43
|
+
testpaths = ["tests"]
|