Skip to content

Commit 66b85f5

Browse files
Doc
1 parent 82dba07 commit 66b85f5

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -673,14 +673,7 @@ AEMC distinguishes between **local** and **remote** AEM instances:
673673
| **Local** | Instances running on developer's machine, fully managed by AEMC | Create, Start, Stop, Delete, Backup, filesystem access, JVM options, run modes |
674674
| **Remote** | Any AEM instance accessible via HTTP (cloud, VMs, etc.) | HTTP-based operations only: packages, OSGi, repository, replication |
675675

676-
This distinction is reflected in the codebase and CLI:
677-
678-
- **`aem instance`** commands work with any instance (local or remote)
679-
- **`aem instance local`** commands are specific to locally managed instances
680-
681-
When configuring instances, AEMC automatically determines the type based on the `http_url`:
682-
- URLs with `localhost` or `127.0.0.1` → treated as **local**
683-
- Other URLs → treated as **remote**
676+
Commands like `instance create`, `start`, `stop`, `delete`, `backup` operate only on local instances. Commands like `package deploy`, `osgi config`, `repo node` work with any instance.
684677

685678
## Instance ID Naming Convention
686679

@@ -692,9 +685,9 @@ Each instance has a unique ID following the pattern: **`{location}_{role}[_{clas
692685
| **role** | Yes | `author`, `publish` | AEM instance role |
693686
| **classifier** | No | `1`, `2`, `preview`, or custom | Distinguishes multiple instances with same location and role |
694687

695-
> **⚠️ Important:** The `local` location prefix is **required** for local instance management commands (`aem instance local create`, `start`, `stop`, `launch`, `delete`, `backup`, etc.).
688+
> **⚠️ Important:** The `local` location prefix is **required** for local instance management commands (`aem instance create`, `start`, `stop`, `launch`, `delete`, `backup`, etc.).
696689
>
697-
> Instances with any other location (e.g., `int_`, `stg_`, `prod_`) are treated as **remote** and will be **skipped** by local management commands, even if their `http_url` points to localhost.
690+
> Instances with any other location (e.g., `int_`, `stg_`, `prod_`) are treated as **remote** and will be **skipped** by these commands, even if their `http_url` points to localhost.
698691
699692
### Example Instance IDs
700693

@@ -764,20 +757,20 @@ export AEM_INSTANCE_CONFIG_INT_AUTHOR_ACTIVE=true
764757

765758
```shell
766759
# Create and start local AEM instances
767-
sh aemw instance local create
768-
sh aemw instance local start
760+
sh aemw instance create
761+
sh aemw instance start
769762

770763
# Or do both in one command
771-
sh aemw instance local launch
764+
sh aemw instance launch
772765

773766
# Check instance status
774767
sh aemw instance status
775768

776769
# Stop instances
777-
sh aemw instance local stop
770+
sh aemw instance stop
778771

779772
# Delete instances (removes all data)
780-
sh aemw instance local delete
773+
sh aemw instance delete
781774
```
782775

783776
## Deploying Packages
@@ -861,7 +854,7 @@ sh aemw instance backup perform
861854
# ...
862855

863856
# 3. Something went wrong? Delete and restore from backup
864-
sh aemw instance local delete --kill
857+
sh aemw instance delete --kill
865858
sh aemw instance backup restore
866859
```
867860

0 commit comments

Comments
 (0)