@oked/scan 0.0.0-stage → 0.6.25
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/LICENSE +201 -0
- package/README.md +146 -2
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +132 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +4 -0
- package/dist/read.d.ts +29 -0
- package/dist/read.js +370 -0
- package/dist/redact.d.ts +20 -0
- package/dist/redact.js +69 -0
- package/dist/report.d.ts +84 -0
- package/dist/report.js +439 -0
- package/dist/rules.d.ts +23 -0
- package/dist/rules.js +63 -0
- package/package.json +59 -4
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 the 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 the 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 any 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 [yyyy] [name of copyright owner]
|
|
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/README.md
CHANGED
|
@@ -1,3 +1,147 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @oked/scan
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@oked/scan)
|
|
4
|
+
[](./LICENSE)
|
|
5
|
+
|
|
6
|
+
Local audit of command history already on this machine. It reads Claude Code transcripts and Codex CLI sessions and shows which commands OKed's default rules would have paused for approval.
|
|
7
|
+
|
|
8
|
+
Nothing leaves the machine. This command does not use the network and it does not send telemetry.
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npx @oked/scan
|
|
12
|
+
npx @oked/scan --since 30
|
|
13
|
+
npx @oked/scan --json
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
The published binary name is `oked-scan` (`npx @oked/scan` runs it). Node.js 18 or newer.
|
|
17
|
+
|
|
18
|
+
Decisions for a later install happen in Telegram or on the [web dashboard](https://oked.ai/dashboard). The iPhone app is coming soon. Questions: [contact@oked.ai](mailto:contact@oked.ai).
|
|
19
|
+
|
|
20
|
+
## What it reads
|
|
21
|
+
|
|
22
|
+
| Source | Where | What counts |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| Claude Code | `~/.claude/projects/**/*.jsonl` | `Bash` tool calls. A missing directory is skipped. |
|
|
25
|
+
| Codex CLI | `~/.codex/sessions/**/rollout-*.jsonl` | Shell tool calls (`shell`, `shell_command`, `exec_command`, `local_shell`, and the same names the Codex hook maps). Other files in that folder, such as `history.jsonl`, are skipped. A missing directory is skipped. |
|
|
26
|
+
|
|
27
|
+
Claude Code lines follow the transcript shape: an `assistant` record whose `message.content` includes a `tool_use` block named `Bash`. A repeated tool id (a streamed line, or a copied record in a forked session) counts once. Codex lines follow the rollout shape: `response_item` / `function_call`, `local_shell_call`, and `exec_command_begin`. A repeated `call_id` counts once, including when a resumed session replays an earlier call.
|
|
28
|
+
|
|
29
|
+
A line that is not JSON is skipped. The report says how many.
|
|
30
|
+
|
|
31
|
+
## How a command is classified
|
|
32
|
+
|
|
33
|
+
Tiers come from `classify()` in [`@oked/sdk`](../sdk), the same function the hooks call. This package does not keep a second copy of the rules. Custom rules are not applied.
|
|
34
|
+
|
|
35
|
+
`review` and `high_stakes` would have paused for a person. `warning` and `safe` would have run.
|
|
36
|
+
|
|
37
|
+
Claude Code is classified with the Bash sandbox not containing child processes, which is the default unless you turn the sandbox on and set `allowUnsandboxedCommands` to false. Test runners and scripts (`npm test`, `cargo test`, `npx`, a script file) then count as `review`. That is what the Claude Code hook does by default: with no sandbox settings, it asks before `npm test`. Codex is classified the way [`@oked/codex`](../codex) classifies commands: that option is omitted, so the same runners stay allowed. One command can therefore differ by host. `oked-scan --verbose` prints these notes. The default text report leaves the notes out, and it puts those runners on their own line instead of hiding them.
|
|
38
|
+
|
|
39
|
+
The text report uses plain words. Tiers are "High-stakes (always asks)", "Worth a look (asks)", "Runs, logged", and "Runs". Kinds are "rm -rf / file delete", "force-push", "curl POST/PUT/DELETE", "destructive SQL", "prod deploy", "npm publish", and so on. `--json` keeps the machine names (`high_stakes`, `file_delete`, and the rest) and adds `tierLabel` and `categoryLabel`.
|
|
40
|
+
|
|
41
|
+
Commands in the report are truncated. Values that look like tokens, passwords, or URL userinfo are replaced with `[redacted]`. A home directory in a command is shown as `~`.
|
|
42
|
+
|
|
43
|
+
## Next step
|
|
44
|
+
|
|
45
|
+
There is no `@oked/cli` package. The report ends with how many commands would have paused, leaving test runners and scripts out of that count, the two or three most common high-stakes kinds in plain words (force-push, rm -rf / file delete, destructive SQL, prod deploy, and so on), then the install command for the history that was found, then `https://oked.ai`. Those runners stay in the totals, on their own line, with how to allow them. If history exists and nothing would have paused, the report says so and does not invent a count. If no Claude Code transcripts and no Codex sessions are found, it says that no history was found at the paths checked, suggests `--path <dir>`, and does not print a zero table. A short line says decisions happen in Telegram or on the web dashboard. The iPhone app is coming soon.
|
|
46
|
+
|
|
47
|
+
| History found | Command |
|
|
48
|
+
|---|---|
|
|
49
|
+
| Claude Code, or none | `npm install -g @oked/claude-code && oked init` |
|
|
50
|
+
| Codex only | `npm install -g @oked/codex && oked-codex init` |
|
|
51
|
+
| Both | `npm install -g @oked/claude-code @oked/codex && oked init && oked-codex init` |
|
|
52
|
+
|
|
53
|
+
Claude Code can also be installed with no global package. In Claude Code: `/plugin marketplace add oked-ai/oked-sdk`, then `/plugin install oked@oked`, then `/oked:pair`. See [plugins/claude-code](../../plugins/claude-code).
|
|
54
|
+
|
|
55
|
+
`@oked/scan` does not install a hook and does not pair a device.
|
|
56
|
+
|
|
57
|
+
## Options
|
|
58
|
+
|
|
59
|
+
| Option | |
|
|
60
|
+
|---|---|
|
|
61
|
+
| `--path <dir>` | Read this directory instead of your home directory. A home layout, `~/.claude/projects`, `~/.codex/sessions`, or a folder of transcript files. |
|
|
62
|
+
| `--since <days>` | Only commands timestamped in the last `<days>` days. Commands with no timestamp are still included. |
|
|
63
|
+
| `--verbose` | Print how commands are classified. The default text report leaves those notes out. |
|
|
64
|
+
| `--json` | Print the report as JSON. This ignores `--verbose`. |
|
|
65
|
+
| `--version` | Print the package version. |
|
|
66
|
+
| `-h`, `--help` | Show the usage text. |
|
|
67
|
+
|
|
68
|
+
Exit code 0 when the report is printed, including when no transcripts were found. Exit code 1 when the arguments are wrong or `--path` does not exist.
|
|
69
|
+
|
|
70
|
+
## Sample
|
|
71
|
+
|
|
72
|
+
The counts below are the fixture transcripts in this package (`test/fixtures`), not a person's machine. `npm test` asks for Claude Code and does not ask for Codex, because those are the two hook defaults. The Claude Code one is the routine line. It stays in "Would have paused" and out of the closing count. `vercel --prod` is high-stakes, kind `deploy`. The Claude Code curl is past the top 8. In the JSON report it is `curl -X POST https://example.com/hook -H "Authorization: Bearer [redacted]" -d hi`. When no history is found, the report says so and does not print a zero table.
|
|
73
|
+
|
|
74
|
+
<!-- fixture-report -->
|
|
75
|
+
```
|
|
76
|
+
OKed scan 0.6.25
|
|
77
|
+
Local only. This scan does not use the network and does not send telemetry.
|
|
78
|
+
|
|
79
|
+
Claude Code 9 commands in 2 files
|
|
80
|
+
Codex CLI 7 commands in 2 files
|
|
81
|
+
Window all history
|
|
82
|
+
Skipped 1 unreadable line.
|
|
83
|
+
|
|
84
|
+
Commands 16
|
|
85
|
+
Would have paused 10
|
|
86
|
+
High-stakes (always asks) 7
|
|
87
|
+
Destructive or hard to undo.
|
|
88
|
+
Worth a look (asks) 3
|
|
89
|
+
OKed asks before it runs.
|
|
90
|
+
Would have run 6
|
|
91
|
+
Runs, logged 2
|
|
92
|
+
It runs, and OKed logs it.
|
|
93
|
+
Runs 4
|
|
94
|
+
It runs. No log line.
|
|
95
|
+
|
|
96
|
+
What would pause
|
|
97
|
+
7 high-stakes: 3 rm -rf / file delete, 2 force-pushes, 2 prod deploys
|
|
98
|
+
3 worth a look: 2 curl POST/PUT/DELETE, 1 test runner
|
|
99
|
+
|
|
100
|
+
Top risky commands
|
|
101
|
+
High-stakes (always asks)
|
|
102
|
+
1 claude-code force-push git push --force origin main
|
|
103
|
+
1 claude-code force-push git push --force origin other
|
|
104
|
+
1 claude-code rm -rf / file delete rm -rf /etc/old
|
|
105
|
+
1 claude-code rm -rf / file delete rm -rf /var/data
|
|
106
|
+
1 codex rm -rf / file delete rm -rf /var/data
|
|
107
|
+
1 claude-code prod deploy vercel --prod
|
|
108
|
+
1 codex prod deploy vercel --prod
|
|
109
|
+
Worth a look (asks)
|
|
110
|
+
1 codex curl POST/PUT/DELETE bash -lc 'curl -X POST https://example.com/hook -d hi'
|
|
111
|
+
Showing 8 of 10. Re-run with --json for every paused command.
|
|
112
|
+
|
|
113
|
+
1 routine command (test runners, scripts) would also ask under Claude Code's default sandbox setting.
|
|
114
|
+
To allow those without a prompt, turn on the Bash sandbox and set allowUnsandboxedCommands to false in ~/.claude/settings.json or .claude/settings.local.json.
|
|
115
|
+
|
|
116
|
+
Decisions happen in Telegram or on the web dashboard (https://oked.ai/dashboard). The iPhone app is coming soon.
|
|
117
|
+
|
|
118
|
+
OKed would have paused 9 of these commands, including 3 rm -rf / file delete, 2 force-pushes and 2 prod deploys.
|
|
119
|
+
Get a yes/no in Telegram before your agent runs them:
|
|
120
|
+
npm install -g @oked/claude-code @oked/codex && oked init && oked-codex init
|
|
121
|
+
https://oked.ai
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
An empty home, with no transcript directory, says that no history was found. It does not print a zero table, and it does not invent a paused count.
|
|
125
|
+
|
|
126
|
+
<!-- empty-report -->
|
|
127
|
+
```
|
|
128
|
+
OKed scan 0.6.25
|
|
129
|
+
Local only. This scan does not use the network and does not send telemetry.
|
|
130
|
+
|
|
131
|
+
Claude Code no transcripts at ~/.claude/projects
|
|
132
|
+
Codex CLI no sessions at ~/.codex/sessions
|
|
133
|
+
Window all history
|
|
134
|
+
|
|
135
|
+
No Claude Code or Codex history was found at the paths checked.
|
|
136
|
+
Pass --path <dir> to read a different directory.
|
|
137
|
+
|
|
138
|
+
Decisions happen in Telegram or on the web dashboard (https://oked.ai/dashboard). The iPhone app is coming soon.
|
|
139
|
+
|
|
140
|
+
Get a yes/no in Telegram before your agent runs a risky command:
|
|
141
|
+
npm install -g @oked/claude-code && oked init
|
|
142
|
+
https://oked.ai
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## License
|
|
146
|
+
|
|
147
|
+
[Apache-2.0](./LICENSE)
|
package/dist/cli.d.ts
ADDED
package/dist/cli.js
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { readFileSync } from "node:fs";
|
|
3
|
+
import { homedir } from "node:os";
|
|
4
|
+
import { formatReport, scan, ScanUsageError } from "./report.js";
|
|
5
|
+
const USAGE = `Usage: oked-scan [options]
|
|
6
|
+
|
|
7
|
+
Read local Claude Code transcripts and Codex CLI sessions. Print which
|
|
8
|
+
commands OKed's default rules would have paused for approval.
|
|
9
|
+
|
|
10
|
+
This command stays on this machine. It does not use the network and it
|
|
11
|
+
does not send telemetry.
|
|
12
|
+
|
|
13
|
+
Looks in ~/.claude/projects/**/*.jsonl (Bash tool calls) and
|
|
14
|
+
~/.codex/sessions/**/rollout-*.jsonl (shell tool calls). A missing
|
|
15
|
+
directory is skipped.
|
|
16
|
+
|
|
17
|
+
Options:
|
|
18
|
+
--path <dir> Read this directory instead of your home directory.
|
|
19
|
+
A home layout (~/.claude/projects, ~/.codex/sessions),
|
|
20
|
+
one of those folders, or a directory of transcript files.
|
|
21
|
+
--since <days> Only commands timestamped in the last <days> days.
|
|
22
|
+
Commands with no timestamp are still included.
|
|
23
|
+
--verbose Print how commands are classified.
|
|
24
|
+
--json Print the report as JSON. This ignores --verbose.
|
|
25
|
+
--version Print the package version.
|
|
26
|
+
-h, --help Show this help.
|
|
27
|
+
|
|
28
|
+
Exit code 0 when the report is printed, including when nothing was found.
|
|
29
|
+
Exit code 1 when the arguments are wrong or --path does not exist.
|
|
30
|
+
|
|
31
|
+
The text report uses plain words for tiers and command kinds. --json
|
|
32
|
+
keeps the machine names and adds label fields. The report ends with how
|
|
33
|
+
many commands would have paused, the install command for the history
|
|
34
|
+
that was found, and https://oked.ai. When no transcripts and no sessions
|
|
35
|
+
are found, it says so and suggests --path. It does not print a zero table.
|
|
36
|
+
For example:
|
|
37
|
+
npm install -g @oked/claude-code && oked init
|
|
38
|
+
npm install -g @oked/codex && oked-codex init
|
|
39
|
+
`;
|
|
40
|
+
function fail(message) {
|
|
41
|
+
process.stderr.write(`${message}\n`);
|
|
42
|
+
process.exitCode = 1;
|
|
43
|
+
throw new ScanUsageError(message);
|
|
44
|
+
}
|
|
45
|
+
function parseArgs(argv) {
|
|
46
|
+
const flags = { json: false, verbose: false };
|
|
47
|
+
for (let i = 0; i < argv.length; i += 1) {
|
|
48
|
+
const arg = argv[i];
|
|
49
|
+
if (arg === "--version")
|
|
50
|
+
continue;
|
|
51
|
+
if (arg === "--json") {
|
|
52
|
+
flags.json = true;
|
|
53
|
+
continue;
|
|
54
|
+
}
|
|
55
|
+
if (arg === "--verbose") {
|
|
56
|
+
flags.verbose = true;
|
|
57
|
+
continue;
|
|
58
|
+
}
|
|
59
|
+
const sinceEq = arg.match(/^--since=(.*)$/);
|
|
60
|
+
const pathEq = arg.match(/^--path=(.*)$/);
|
|
61
|
+
if (arg === "--since" || sinceEq) {
|
|
62
|
+
const raw = sinceEq ? sinceEq[1] : argv[++i];
|
|
63
|
+
if (raw === undefined || raw.startsWith("-"))
|
|
64
|
+
fail("Usage: --since <days>");
|
|
65
|
+
if (!/^\d+$/.test(raw))
|
|
66
|
+
fail("--since expects a whole number of days (0 or more)");
|
|
67
|
+
flags.since = Number(raw);
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
if (arg === "--path" || pathEq) {
|
|
71
|
+
const raw = pathEq ? pathEq[1] : argv[++i];
|
|
72
|
+
if (!raw || raw.startsWith("-"))
|
|
73
|
+
fail("Usage: --path <dir>");
|
|
74
|
+
flags.path = raw;
|
|
75
|
+
continue;
|
|
76
|
+
}
|
|
77
|
+
fail(`Unknown argument: ${arg}\n${USAGE}`);
|
|
78
|
+
}
|
|
79
|
+
return flags;
|
|
80
|
+
}
|
|
81
|
+
function packageVersion() {
|
|
82
|
+
const json = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
|
|
83
|
+
return json.version ?? "0.0.0";
|
|
84
|
+
}
|
|
85
|
+
async function main() {
|
|
86
|
+
const argv = process.argv.slice(2);
|
|
87
|
+
if (argv.includes("-h") || argv.includes("--help")) {
|
|
88
|
+
process.stdout.write(USAGE);
|
|
89
|
+
return 0;
|
|
90
|
+
}
|
|
91
|
+
if (argv.length === 1 && argv[0] === "--version") {
|
|
92
|
+
process.stdout.write(`${packageVersion()}\n`);
|
|
93
|
+
return 0;
|
|
94
|
+
}
|
|
95
|
+
let flags;
|
|
96
|
+
try {
|
|
97
|
+
flags = parseArgs(argv);
|
|
98
|
+
}
|
|
99
|
+
catch (err) {
|
|
100
|
+
if (err instanceof ScanUsageError)
|
|
101
|
+
return 1;
|
|
102
|
+
throw err;
|
|
103
|
+
}
|
|
104
|
+
try {
|
|
105
|
+
const report = await scan({
|
|
106
|
+
root: flags.path ?? homedir(),
|
|
107
|
+
explicitRoot: flags.path !== undefined,
|
|
108
|
+
sinceDays: flags.since,
|
|
109
|
+
});
|
|
110
|
+
if (flags.json)
|
|
111
|
+
process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
|
|
112
|
+
else
|
|
113
|
+
process.stdout.write(formatReport(report, { verbose: flags.verbose }));
|
|
114
|
+
return 0;
|
|
115
|
+
}
|
|
116
|
+
catch (err) {
|
|
117
|
+
if (err instanceof ScanUsageError) {
|
|
118
|
+
process.stderr.write(`${err.message}\n`);
|
|
119
|
+
return 1;
|
|
120
|
+
}
|
|
121
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
122
|
+
process.stderr.write(`${message}\n`);
|
|
123
|
+
return 1;
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
main().then((code) => {
|
|
127
|
+
process.exitCode = code;
|
|
128
|
+
}, (err) => {
|
|
129
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
130
|
+
process.stderr.write(`${message}\n`);
|
|
131
|
+
process.exitCode = 1;
|
|
132
|
+
});
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { displayCommand, redactSecrets, argvToShell, quoteArg } from "./redact.js";
|
|
2
|
+
export { collectCommands, type RawCommand, type Collected } from "./read.js";
|
|
3
|
+
export { SHELL_TOOL_NAMES, classifyCommand, pausesForApproval, classifierVersion, type Host, } from "./rules.js";
|
|
4
|
+
export { scan, formatReport, nextStep, ScanUsageError, type ScanOptions, type FormatReportOptions, type ScanReport, type CommandRow, type RiskyGroup, type HostSummary, } from "./report.js";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { displayCommand, redactSecrets, argvToShell, quoteArg } from "./redact.js";
|
|
2
|
+
export { collectCommands } from "./read.js";
|
|
3
|
+
export { SHELL_TOOL_NAMES, classifyCommand, pausesForApproval, classifierVersion, } from "./rules.js";
|
|
4
|
+
export { scan, formatReport, nextStep, ScanUsageError, } from "./report.js";
|
package/dist/read.d.ts
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { type Host } from "./rules.js";
|
|
2
|
+
export interface RawCommand {
|
|
3
|
+
host: Host;
|
|
4
|
+
command: string;
|
|
5
|
+
/** ISO timestamp from the transcript, when the line had one. */
|
|
6
|
+
timestamp: string | null;
|
|
7
|
+
/** Stable id used to count a copied or streamed tool call once. */
|
|
8
|
+
id: string;
|
|
9
|
+
}
|
|
10
|
+
export interface HostScan {
|
|
11
|
+
directory: string;
|
|
12
|
+
present: boolean;
|
|
13
|
+
files: number;
|
|
14
|
+
commands: number;
|
|
15
|
+
}
|
|
16
|
+
export interface Collected {
|
|
17
|
+
commands: RawCommand[];
|
|
18
|
+
hosts: Record<Host, HostScan>;
|
|
19
|
+
badLines: number;
|
|
20
|
+
unreadableFiles: number;
|
|
21
|
+
}
|
|
22
|
+
export interface CollectOptions {
|
|
23
|
+
root: string;
|
|
24
|
+
/** When false, a home directory with no transcript folders is not walked. */
|
|
25
|
+
explicitRoot: boolean;
|
|
26
|
+
sinceMs: number | null;
|
|
27
|
+
nowMs: number;
|
|
28
|
+
}
|
|
29
|
+
export declare function collectCommands(options: CollectOptions): Promise<Collected>;
|