@elaraai/e3-cloud-codex-plugin 0.0.0-stage → 1.0.90-alpha.0

package/README.md

@@ -1,3 +1,66 @@
-# Temporary Holding Version
+# e3 cloud plugin for Codex
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+e3 cloud for Codex: the `e3-cloud-ui`, `e3-cloud-cli` and `e3-cloud-client`
+skills, the example search and the search-first hook, as the Claude Code
+plugin has them. Install it beside East's Codex plugin, which covers East, e3
+and e3-ui.
+
+The plugin is the npm package `@elaraai/e3-cloud-codex-plugin`: its bundles,
+its skills as real files (Codex caches only the plugin; each adapted to
+Codex's names) and the example index, with no dependency. Installing it needs
+no build.
+
+## Installation
+
+Requires Node.js 22+ on `PATH` and a Codex client with `codex plugin` and
+lifecycle hooks. The public catalog
+[elaraai/plugins](https://github.com/elaraai/plugins) is a Codex marketplace,
+named `elaraai-codex`, that lists the plugin at the version each release
+publishes:
+
+```bash
+codex plugin marketplace add elaraai/plugins
+codex plugin add e3-cloud-codex-plugin@elaraai-codex
+codex plugin add east-codex-plugin@elaraai-codex      # East's, beside it
+```
+
+Start a new Codex thread, open `/hooks` and trust the e3 cloud hook:
+installation alone does not trust its command. Ask Codex to call
+`search_e3_cloud_examples` with `query: "release staging to production"`.
+
+A new release reaches you with `codex plugin marketplace upgrade elaraai-codex`,
+then removing and adding the plugin. Pre-releases are the catalog's `beta`
+branch (`codex plugin marketplace add elaraai/plugins --ref beta`, named
+`elaraai-codex-beta`).
+
+## The hook
+
+Codex runs one hook for every tool (east-plugin's `codexSearchGate` with e3
+cloud's names): after a search of e3 cloud's index or East's it records the
+search; before a call it reminds a read of
+`node_modules/@elaraai/e3-cloud-{ui,cli,client}`, and tells the first write of
+code importing `@elaraai/e3-cloud-ui` or `@elaraai/e3-cloud-client` with no
+search recorded to search first (`E3_CLOUD_REQUIRE_SEARCH=deny`: a refusal).
+
+## Developing it
+
+In e3 cloud's repository, `pnpm run plugins` (or `make plugins`) bundles the
+plugin and assembles it, as npm publishes it, under
+`packages/e3-cloud-plugin/marketplace/`: a local marketplace named
+`elaraai-e3-cloud-codex`. Remove the catalog's
+`e3-cloud-codex-plugin@elaraai-codex` first, since both are named
+`e3-cloud-codex-plugin`, then:
+
+```bash
+codex plugin marketplace add <checkout>/packages/e3-cloud-plugin/marketplace
+codex plugin add e3-cloud-codex-plugin@elaraai-e3-cloud-codex
+```
+
+Installed plugins run from a cached copy: after a rebuild, remove and add the
+plugin again, and start a new thread. The shared package's README
+(`packages/e3-cloud-plugin/README.md`) says how to change it.
+
+## License
+
+Dual-licensed under AGPL-3.0 and a commercial license. See
+[LICENSE.md](LICENSE.md).

package/hooks/hooks.json

@@ -0,0 +1,29 @@
+{
+  "description": "e3 cloud plugin hooks: the search-before-coding gate for code using @elaraai/e3-cloud-ui or @elaraai/e3-cloud-client, and a reminder on reading their installed packages",
+  "hooks": {
+    "PreToolUse": [
+      {
+        "matcher": "apply_patch|Bash|exec_command|shell_command|Read|Edit|Write|Grep|Glob|mcp__.*__(?:search_e3_cloud_examples|get_e3_cloud_example|search_east_examples|get_east_example)$",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "node \"${PLUGIN_ROOT}/.build/hooks/codex-tools.js\"",
+            "timeout": 30
+          }
+        ]
+      }
+    ],
+    "PostToolUse": [
+      {
+        "matcher": "mcp__.*__(?:search_e3_cloud_examples|get_e3_cloud_example|search_east_examples|get_east_example)$",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "node \"${PLUGIN_ROOT}/.build/hooks/codex-tools.js\"",
+            "timeout": 30
+          }
+        ]
+      }
+    ]
+  }
+}