add API and server command

memo33 · Nov 19, 2023 · a5e4cee · a5e4cee
1 parent 59d7538
commit a5e4cee
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,6 +1,7 @@
 - Guide
   * [Getting started](/)
   * [CLI](cli.md)
+  * [API](api.md)
   * [About](about.md)
 - Packages
   * [Highlights](packages.md)

diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,8 @@
+?> This documentation page is for developers. Skip to the next page: [About](about.md).
+
+[sc4pac-tools-api](https://raw.githubusercontent.com/memo33/sc4pac-tools/main/api.md ':include')
+
+<!-- [sc4pac-tools-api](sc4pac-tools-api.md ':include') -->
+
+---
+Next up: [About](about.md)
diff --git a/docs/cli.md b/docs/cli.md
@@ -170,4 +170,22 @@ sc4pac channel build --output "channel/json/" "channel/yaml/"
 
 
 ---
-Next up: [About](about.md)
+## server
+
+**Usage:** `sc4pac server [options]`
+
+Start a local server to use the HTTP [API](api).
+
+**Example:**
+```
+sc4pac server --indent 2 --scope-root scopes/scope-1/
+```
+
+**Options:**
+- `--port number`      (default: 51515)
+- `--indent number`    indentation of JSON responses (default: -1, no indentation)
+- `--scope-root path`  root directory containing `sc4pac-plugins.json` (default: current working directory), newly created if necessary; can be used for managing multiple different plugins folders
+
+
+---
+Next up: [API](api.md)