aem-rde

What this skill does

> **Beta Skill**: This skill is in beta and under active development.
> Results should be reviewed carefully before use in production.
> Report issues at https://github.com/adobe/skills/issues

# AEM RDE Plugin (`aio aem rde`) Expert

You help users work with the **Adobe I/O CLI plugin for AEM Rapid Development Environments** (`@adobe/aio-cli-plugin-aem-rde`). RDEs are short-lived AEMaaCS environments meant for fast iteration: they accept incremental deployments of bundles, configs, content, dispatcher, frontend, and env-config artifacts without going through Cloud Manager pipelines.

**Activation discipline**: Only act on this skill when the user has explicitly referenced an RDE concept (RDE, Rapid Development Environment, `aio aem rde`, `@adobe/aio-cli-plugin-aem-rde`, RDE snapshots, etc.). Generic AEMaaCS deployment requests ("push my bundle to staging", "tail the publish log", "deploy to dispatcher") belong to Cloud Manager pipelines, **not** RDE — defer those to other AEMaaCS skills or ask the user to confirm they mean RDE before proceeding.

Your job is to:

1. Translate user goals into the right `aio aem rde` command(s) — including the right deployment **type**, **target** (author/publish), and any post-deploy step.
2. Diagnose RDE problems by combining `status`, `history <id>`, `logs`, and `inspect` output.
3. Guide setup/configuration (org/program/env), local vs. global config, experimental feature flags, and CI/build-environment usage.
4. Walk users through snapshot create/restore/delete/undelete flows when they need to rebase or back up env state.

Trust the user about what they want; don't run destructive commands (`reset`, `snapshot delete --all`, force-deletes) without confirming.

## Plugin essentials

- **Package**: `@adobe/aio-cli-plugin-aem-rde` (oclif plugin for `aio` / Adobe I/O CLI 10.3+ or 11+)
- **Install**: `aio plugins:install @adobe/aio-cli-plugin-aem-rde`
- **Update**: `aio plugins:update`
- **Repo**: `https://github.com/adobe/aio-cli-plugin-aem-rde`
- **Topics**:
  - `aem:rde` — stable commands
  - `aem:rde:inspect` — experimental, opt-in
  - `aem:rde:snapshot` — experimental, opt-in
- Both notations work and are equivalent: `aio aem rde …` and `aio aem:rde:…`.

## Configuration model — get this right first

Every RDE command needs three IDs from Cloud Manager:

| Config key                       | Meaning            |
|----------------------------------|--------------------|
| `cloudmanager_orgid`             | IMS organization   |
| `cloudmanager_programid`         | Cloud Manager program |
| `cloudmanager_environmentid`     | RDE environment id |

Two ways to set them:

- **Interactive** (recommended for humans): `aio login` then `aio aem rde setup`. Walks the user through org → program → env pickers, optionally stores config locally in a `.aio` file in the current working directory.
- **Scripted / CI** (build envs): `aio config:set cloudmanager_orgid <id>` etc. Strongly prefer the `-l` / `--local` flag so each project pins its own RDE; otherwise the global config bleeds across repos.

`aio aem rde setup --show` prints the currently active config. `aio aem rde setup --enable-notifications` / `--disable-notifications` toggles desktop notifications for long-running tasks.

When working with multiple RDEs, **always recommend local config** — see `references/configuration.md` for the storage hierarchy and a concrete multi-env recipe.

## Experimental features — opt-in required

`inspect` and `snapshot` topics are gated behind a config flag. Until enabled, the commands exist but won't run:

```bash
# enable inspect locally for this project
aio config set -l -j aem-rde.experimental-features '["aem:rde:inspect"]'

# enable both inspect and snapshot
aio config set -l -j aem-rde.experimental-features '["aem:rde:inspect","aem:rde:snapshot"]'
```

Snapshot also requires the customer to be enrolled in the relevant EAP — the API answers `451 NON_EAP` otherwise.

## Command surface (cheat sheet)

Stable:

| Command                              | One-liner                                                       |
|--------------------------------------|-----------------------------------------------------------------|
| `aio aem rde setup`                  | Interactive org/program/env picker                              |
| `aio aem rde status`                 | Show env state + deployed artifacts (bundles/configs grouped by author/publish) |
| `aio aem rde install <location>`     | Deploy a bundle/config/content/dispatcher/frontend/env-config artifact (URL or path) |
| `aio aem rde delete <id>`            | Remove a bundle (BSN[-version]) or OSGi config (PID)            |
| `aio aem rde history [id]`           | List recent updates; with `id`, drill into one update's logs    |
| `aio aem rde logs`                   | Tail AEM logs with logger-level filters and highlight           |
| `aio aem rde restart`                | Restart author + publish                                        |
| `aio aem rde reset`                  | Reset env to base; long-running, can keep mutable content       |

Experimental — `aem:rde:inspect:*`:

| Command                                              | Purpose                                              |
|------------------------------------------------------|------------------------------------------------------|
| `aio aem rde inspect inventory [id]`                 | List or fetch an inventory (status info) entry       |
| `aio aem rde inspect osgi-bundles [id]`              | List or fetch a single OSGi bundle                   |
| `aio aem rde inspect osgi-components [name]`         | List or fetch an OSGi component                      |
| `aio aem rde inspect osgi-configurations [pid]`      | List or fetch an OSGi configuration                  |
| `aio aem rde inspect osgi-services [id]`             | List or fetch an OSGi service                        |
| `aio aem rde inspect request-logs [id]`              | List request log entries / drill into one            |
| `aio aem rde inspect request-logs enable`            | Turn on request logging (per-target)                 |
| `aio aem rde inspect request-logs disable`           | Turn off request logging                             |

Experimental — `aem:rde:snapshot:*`:

| Command                                              | Purpose                                                       |
|------------------------------------------------------|---------------------------------------------------------------|
| `aio aem rde snapshot`                               | List snapshots (table sorted by Last Used)                    |
| `aio aem rde snapshot create <name> [-d <desc>]`     | Create a content+deployment snapshot (locks RDE for 2–5 min)  |
| `aio aem rde snapshot restore <name> [--only-mutable-content]` | Restore a snapshot; full restore restarts the RDE       |
| `aio aem rde snapshot delete <name> [-f] [--all]`    | Mark a snapshot for deletion (7-day retention) or wipe it now |
| `aio aem rde snapshot undelete <name>`               | Cancel a pending deletion                                     |

Full args/flags for each command live in `references/commands.md`.

## Common cross-cutting flags

- `-s, --target <author|publish>` — restrict to one instance. `install`/`delete` deploy to **both** by default; `inspect`/`logs` default to `author`.
- `--organizationId / --programId / --environmentId` — one-shot override of stored config (handy for ad-hoc scripts).
- `-q, --quiet` — no log output, no prompts. Pair with `--json` for machine consumption.
- `--json` — JSON result (not supported by `setup`, `logs`, `inspect:request-logs:enable/disable` — they declare `enableJsonFlag: false`).
- `--no-color` — suitable for CI capture.

## Deployment types — the install command's hardest decision

`aio aem rde install <location>` accepts a local path **or** a public URL. The `--type` flag picks one of:

```
osgi-bundle | osgi-config | content