simplecloud 0.0.1-beta.78 → 0.0.1-beta.79

package/README.md

@@ -67,6 +67,16 @@ node dist/cli.js --help
 node dist/cli.js start group test
 ```
 
+To test unpublished manifest changes from a local checkout:
+
+```bash
+SC_MANIFEST_DIR=../simplecloud-manifest \
+  bun dist/cli.js install service postgresql --yes
+```
+
+`SC_MANIFEST_DIR` makes both `components.yaml` and referenced service files load
+from that directory instead of the published GitHub manifest.
+
 ### Local Development
 
 **Option 1: Shell Alias (Recommended - No Conflicts)**
@@ -149,6 +159,55 @@ node dist/cli.js start group mygroup
 bunx swagger-typescript-api generate -p swagger.yaml -o src/lib/generated -n simplecloud-api.ts --sort-types --single-http-client --clean-output
 ```
 
+## Installing services during setup
+
+Manifest services are installed into the hidden `.services` directory inside
+the SimpleCloud installation:
+
+```bash
+simplecloud setup --yes --service postgresql
+```
+
+Repeat `--service` to create more instances. Instances receive stable,
+collision-free directory names and incremented default ports:
+
+```bash
+simplecloud setup --yes \
+  --service postgresql \
+  --service 'postgresql@players?database=players'
+```
+
+Service dependencies are resolved automatically. Selecting a database installs
+Docker when needed, verifies Docker Compose, renders all manifest files, and
+starts the service. Docker itself is a host installable and does not receive a
+service directory. Database storage is always backed by a named Docker volume.
+
+Services can also be added to an existing SimpleCloud installation through the
+existing `install` command:
+
+```bash
+simplecloud install service postgresql
+simplecloud install service postgresql \
+  --instance players \
+  --set database=players \
+  --set port=5433
+```
+
+The command uses the active SimpleCloud context, installs missing host
+dependencies such as Docker, writes the instance to `.services/<instance>`,
+and starts it. Use `--dry-run` to validate and inspect the plan without
+changing the installation.
+
+Installed service instances use the same lifecycle syntax as components:
+
+```bash
+simplecloud start postgresql
+simplecloud stop postgresql
+```
+
+Running `simplecloud start` or `simplecloud stop` without targets includes all
+installed components and services. Docker container names include the active
+network slug, for example `my-network-postgresql-database-1`.
 
 ## Publishing to npm