omakit 0.6.1 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -1
- package/package.json +1 -1
- package/tools/blocks/commit.json +2 -2
- package/tools/marketplace/usage.mjs +5 -5
package/README.md
CHANGED
|
@@ -6,7 +6,24 @@
|
|
|
6
6
|
|
|
7
7
|
The three parts are the Run and Store blocks a plugin copies into its own tree, the marketplace's own checks run locally, and repository suites run in a disposable guest. Behind the first are M13's 1,001 security blocker comments from one measured week: 587 raise a Run line, 527 a Store line, and runner plus store handle 777 of 1,001 when read as an upper bound, not as a result for any plugin ([M13](docs/MEASUREMENTS.md#m13-what-the-review-blocks-on-over-one-week-of-comments-and-which-of-it-a-block-can-own)). No reviewer has seen a ported plugin yet.
|
|
8
8
|
|
|
9
|
-
[](https://github.com/tcballard/omarchy-badges) [](https://www.npmjs.com/package/omakit) [](https://github.com/mtolhuys/omakit/actions/workflows/ci.yml)
|
|
9
|
+
[](https://github.com/tcballard/omarchy-badges) [](https://www.npmjs.com/package/omakit) [](https://github.com/mtolhuys/omakit/actions/workflows/ci.yml)
|
|
10
|
+
|
|
11
|
+
## What it delivers
|
|
12
|
+
|
|
13
|
+
| Command | What you get | Documentation |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| `omakit add <block> [<plugin-dir>]` | Copy the Run or Store block into a plugin. The plugin owns the files, and an edited copy is never overwritten. | [Blocks](docs/BLOCKS.md) |
|
|
16
|
+
| `omakit inspect <plugin-dir>` | See what the tree does and what deserves attention, with the file and line for each observation. | [Inspect](docs/INSPECT.md) |
|
|
17
|
+
| `omakit verify <plugin-repo>` | Run the marketplace's own security baseline over the commit and see its result verbatim. | [Commands](docs/COMMANDS.md) |
|
|
18
|
+
| `omakit submit <plugin-repo>` | Run every submission check and get the issue title and body ready to paste. Nothing is posted. | [Submit](docs/SUBMIT.md) |
|
|
19
|
+
| `omakit watch ...` | See whether the marketplace-validated commit is still current and what to do when it is not. | [Watch](docs/VALIDATION_WATCH.md) |
|
|
20
|
+
| `omakit audit [<plugin>]` | Find installed plugins running commits the marketplace never validated. | [Audit](docs/AUDIT.md) |
|
|
21
|
+
| `omakit lab <command>` | Set up, inspect, prove in or prune the disposable Omarchy guest. | [Lab](docs/LAB.md) |
|
|
22
|
+
| `omakit weigh <plugin>` | Measure a plugin's CPU and child processes against the shell's own baseline, then restore the shell config. | [Weigh](docs/WEIGH.md) |
|
|
23
|
+
| `omakit setup`, `omakit doctor` | Prepare or check the pin, completion, tools and disposable lab. | [Install](docs/INSTALL.md) |
|
|
24
|
+
| `omakit pin`, `omakit upgrade`, `omakit parity`, `omakit help --agent` | Maintain Omakit or inspect its own contract and parity proof. | [All commands](docs/COMMANDS.md) |
|
|
25
|
+
|
|
26
|
+
The complete syntax, options, exit codes and JSON/output contract are in the [command reference](docs/COMMANDS.md).
|
|
10
27
|
|
|
11
28
|
## Install
|
|
12
29
|
|
package/package.json
CHANGED
package/tools/blocks/commit.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"commit": "
|
|
3
|
-
"recordedAt": "2026-09-
|
|
2
|
+
"commit": "5c0ee8e01ae87b2faea3183b2bb31684aa017924",
|
|
3
|
+
"recordedAt": "2026-09-19T19:16:02.010Z",
|
|
4
4
|
"how": "Written by `node tools/blocks/record-commit.mjs` in the release workflow before `npm pack`, so a packaged omakit, which has no Git checkout, still names the commit its block files come from. In a checkout this file is null and `git rev-parse HEAD` is the source; a package with null here was packed without the release step, and `omakit add` refuses to stamp a header it cannot name."
|
|
5
5
|
}
|
|
@@ -14,12 +14,12 @@ import { colourEnabled, paintProse, STEP, styler, withOutputStream, wrap } from
|
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
* The line under the wordmark says what the tool is for, and only that: the
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
17
|
+
* public README banner says: tested plumbing for plugins. It is never a claim
|
|
18
|
+
* about the security of a plugin or a submission; the baseline's outcome is
|
|
19
|
+
* reported verbatim and is never restated as one, and a block is described by
|
|
20
|
+
* what it does and what was measured.
|
|
21
21
|
*/
|
|
22
|
-
export const TAGLINE = "
|
|
22
|
+
export const TAGLINE = "tested plumbing for plugins"
|
|
23
23
|
|
|
24
24
|
/** The shells `omakit setup` installs tab completion for; completion.mjs holds the scripts. */
|
|
25
25
|
export const COMPLETION_SHELLS = Object.freeze(["bash", "zsh", "fish"])
|