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

package/README.md

@@ -1,3 +1,89 @@
-# Temporary Holding Version
+# e3 cloud plugin for Claude Code
 
-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.
+A Claude Code plugin for building apps on e3 cloud with `@elaraai/e3-cloud-ui`,
+running deployments with the `e3-cloud` CLI, and driving them from code with
+`@elaraai/e3-cloud-client`. It follows East's plugin, and is installed beside
+it: East's plugin covers East, e3 and e3-ui, which an app's pages are written
+in.
+
+The plugin is the npm package `@elaraai/e3-cloud-claude-plugin`: its bundles,
+skills and example index, with no dependency. Installing it needs no build.
+
+## Installation
+
+Requires Node.js 22+ on `PATH`. The public catalog
+[elaraai/plugins](https://github.com/elaraai/plugins) is a Claude Code
+marketplace, named `elaraai`, that lists the plugin at the version each release
+publishes.
+
+Inside Claude Code:
+```text
+/plugin marketplace add elaraai/plugins
+/plugin install e3-cloud@elaraai
+```
+
+From a terminal:
+```bash
+claude plugin marketplace add elaraai/plugins
+claude plugin install e3-cloud@elaraai
+```
+
+The catalog declares the plugin's dependency on East's, so `east@elaraai` is
+installed with it. Start a new session. A new release reaches you with
+`claude plugin update e3-cloud@elaraai` (or `/plugin marketplace update
+elaraai`), or without asking once auto-update is on for the marketplace under
+**Marketplaces** in `/plugin`. Pre-releases are the catalog's `beta` branch
+(`elaraai/plugins#beta`, named `elaraai-beta`).
+
+## Skills
+
+| Skill | Package | Description |
+|-------|---------|-------------|
+| `e3-cloud-ui` | `@elaraai/e3-cloud-ui` | Apps: `Page` (a thunk body), `Page.task`, `Menu`, `App`, `PageLink`, `Nav`, the build and its refusals, the checks, the East types |
+| `e3-cloud-cli` | `@elaraai/e3-cloud-cli` | The CLI: sign-in, users and roles, secrets, schedules, task configs, records, feedback, apps, releases, history and rollback |
+| `e3-cloud-client` | `@elaraai/e3-cloud-client` | Driving a deployment from code |
+
+## Example search
+
+The plugin's MCP server (`e3-cloud`) serves e3 cloud's example index:
+
+- **`search_e3_cloud_examples(query, language, format, limit, package)`**:
+  summaries by default (id, description, keywords), `format: "full"` for the
+  code.
+- **`get_e3_cloud_example(id, language)`**: one example in full.
+
+It holds `@elaraai/e3-cloud-ui`'s page bodies, and hand-written entries for
+`App`, `Page.task`, `buildApp` and `checkApp`, every CLI command, and the
+client's calls. The `PreToolUse(Edit|Write)` hook is the gate: the first write
+of code importing `@elaraai/e3-cloud-ui` or `@elaraai/e3-cloud-client` in a
+session with no search on record (of e3 cloud's index or East's) is told to
+search first; `E3_CLOUD_REQUIRE_SEARCH=deny` makes it a refusal. A `Read`,
+`Grep` or `Glob` of `node_modules/@elaraai/e3-cloud-{ui,cli,client}` is
+reminded that the index is the same code, cheaper.
+
+## Version
+
+The @elaraai lockstep, as every e3 cloud package's: the release of e3 cloud's
+packages is the release of this plugin.
+
+## 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`. Uninstall the catalog's `e3-cloud@elaraai` first, since
+both are named `e3-cloud`, then:
+
+```bash
+claude plugin marketplace add <checkout>/packages/e3-cloud-plugin/marketplace
+claude plugin install e3-cloud@elaraai-e3-cloud
+```
+
+After a rebuild, `claude plugin marketplace update elaraai-e3-cloud` and a new
+session take it up. 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,27 @@
+{
+  "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": "Edit|Write",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "node \"${CLAUDE_PLUGIN_ROOT}/.build/hooks/pre-write.js\"",
+            "timeout": 3
+          }
+        ]
+      },
+      {
+        "matcher": "Read|Grep|Glob",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "node \"${CLAUDE_PLUGIN_ROOT}/.build/hooks/pre-read.js\"",
+            "timeout": 3
+          }
+        ]
+      }
+    ]
+  }
+}