@nocobase/plugin-ai 2.1.0-beta.46 → 2.1.0-beta.48

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/current.md

@@ -0,0 +1,33 @@
+---
+title: "nb proxy caddy current"
+description: "nb proxy caddy current command reference: print the current Caddy provider driver."
+keywords: "nb proxy caddy current,NocoBase CLI,caddy,driver"
+---
+
+# nb proxy caddy current
+
+Print the current Caddy provider driver.
+
+## Usage
+
+```bash
+nb proxy caddy current
+```
+
+## Output
+
+The command prints one value directly:
+
+- `local`
+- `docker`
+
+## Examples
+
+```bash
+nb proxy caddy current
+```
+
+## Related commands
+
+- [`nb proxy caddy use`](./use.md)
+- [`nb proxy caddy info`](./info.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/generate.md

@@ -0,0 +1,54 @@
+---
+title: "nb proxy caddy generate"
+description: "nb proxy caddy generate command reference: generate or refresh the Caddy config for one CLI-managed env."
+keywords: "nb proxy caddy generate,NocoBase CLI,caddy,reverse proxy,proxy configuration"
+---
+
+# nb proxy caddy generate
+
+Generate or refresh the Caddy entry config for one CLI-managed env.
+
+## Usage
+
+```bash
+nb proxy caddy generate --env <name> [--host <domain>] [--port <port>]
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `--env`, `-e` | string | CLI-managed env name to generate the config for |
+| `--host` | string | Host written into the site address, such as `app1.example.com` |
+| `--port` | string | Listen port written into the site address, such as `8080` |
+
+## Generated files
+
+Using env `test2` as an example, the command typically maintains these files and directories:
+
+- `NB_CLI_ROOT/.nocobase/proxy/caddy/nocobase.caddy`
+- `NB_CLI_ROOT/.nocobase/proxy/caddy/test2/app.caddy`
+- `NB_CLI_ROOT/.nocobase/proxy/caddy/test2/public/index-v1.html`
+- `NB_CLI_ROOT/.nocobase/proxy/caddy/test2/public/index-v2.html`
+
+In the current design, `app.caddy` is already the complete site config for one env and is no longer split into a separate `generated.caddy` file.
+
+## Examples
+
+```bash
+nb proxy caddy generate --env demo --host demo.local.nocobase.com
+nb proxy caddy generate --env demo --host demo.local.nocobase.com --port 8080
+```
+
+## Notes
+
+- `generate` only writes or refreshes config and does not automatically start Caddy
+- Regenerating config overwrites `app.caddy` as a whole
+- If you change settings such as `app-port` or `app-public-path` with `nb env update`, you will usually need to rerun this command
+- Only CLI-managed `local` or `docker` envs can use this command
+
+## Related commands
+
+- [`nb proxy caddy start`](./start.md)
+- [`nb proxy caddy reload`](./reload.md)
+- [`nb env update`](../../env/update.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/index.md

@@ -0,0 +1,60 @@
+---
+title: "nb proxy caddy"
+description: "nb proxy caddy command-group reference: manage the Caddy provider driver, config generation, and runtime control."
+keywords: "nb proxy caddy,NocoBase CLI,caddy,reverse proxy,proxy configuration"
+---
+
+# nb proxy caddy
+
+`nb proxy caddy` is the command-group entry for the Caddy provider.
+
+If you already have a domain, want to get HTTPS running quickly, and do not want to maintain too many TLS details yourself, this is usually the place to start. It handles two things:
+
+- choosing how Caddy runs, which means `local` or `docker`
+- generating, starting, reloading, and inspecting the Caddy entrypoint for CLI-managed envs
+
+## Usage
+
+```bash
+nb proxy caddy <command>
+```
+
+## Subcommands
+
+| Command | Description |
+| --- | --- |
+| [`nb proxy caddy use`](./use.md) | Switch the Caddy driver |
+| [`nb proxy caddy current`](./current.md) | Print the current driver |
+| [`nb proxy caddy generate`](./generate.md) | Generate or refresh the Caddy config for one env |
+| [`nb proxy caddy start`](./start.md) | Start the Caddy proxy |
+| [`nb proxy caddy restart`](./restart.md) | Restart the Caddy proxy |
+| [`nb proxy caddy reload`](./reload.md) | Reload the Caddy config |
+| [`nb proxy caddy stop`](./stop.md) | Stop the Caddy proxy |
+| [`nb proxy caddy status`](./status.md) | Show Caddy runtime status |
+| [`nb proxy caddy info`](./info.md) | Show driver, config paths, and runtime info |
+
+## Notes
+
+- The current driver is stored in `proxy.caddy-driver`
+- The default driver is `local`
+- The local driver uses the executable pointed to by `bin.caddy`, whose default value is `caddy`
+- The Docker driver uses `caddy:latest`
+- The default Docker container name is `<docker.container-prefix>-caddy-proxy`
+- The Docker driver mounts host `NB_CLI_ROOT` into the container at `/apps`
+
+## Typical workflow
+
+```bash
+nb proxy caddy use local
+nb proxy caddy generate --env app1 --host app1.example.com
+nb proxy caddy start
+nb proxy caddy status
+nb proxy caddy info
+```
+
+## Related commands
+
+- [`nb proxy`](../index.md)
+- [`nb proxy nginx`](../nginx/index.md)
+- [`nb env update`](../../env/update.md)
+- [`nb config`](../../config/index.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/info.md

@@ -0,0 +1,42 @@
+---
+title: "nb proxy caddy info"
+description: "nb proxy caddy info command reference: show the current Caddy provider driver, config paths, and runtime details."
+keywords: "nb proxy caddy info,NocoBase CLI,caddy,paths,configuration"
+---
+
+# nb proxy caddy info
+
+Show the current Caddy provider driver, config paths, and runtime details.
+
+## Usage
+
+```bash
+nb proxy caddy info
+```
+
+## Output
+
+The output usually includes these fields:
+
+- `driver`
+- `configFile`
+- `runtimeRoot`
+- `upstreamHost`
+- `caddyBinary` or `container`
+- `image`
+
+Where:
+
+- with the `local` driver, the output shows `caddyBinary`
+- with the `docker` driver, the output shows `container` and `image`
+
+## Examples
+
+```bash
+nb proxy caddy info
+```
+
+## Related commands
+
+- [`nb proxy caddy current`](./current.md)
+- [`nb proxy caddy status`](./status.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/reload.md

@@ -0,0 +1,32 @@
+---
+title: "nb proxy caddy reload"
+description: "nb proxy caddy reload command reference: reload the Caddy config with the current driver."
+keywords: "nb proxy caddy reload,NocoBase CLI,caddy,reload"
+---
+
+# nb proxy caddy reload
+
+Reload the Caddy config with the current driver.
+
+## Usage
+
+```bash
+nb proxy caddy reload
+```
+
+## Examples
+
+```bash
+nb proxy caddy reload
+```
+
+## Notes
+
+- This command is typically used after you regenerate the config
+- `reload` requires Caddy to already be running; if it is not running yet, use `nb proxy caddy start` first
+- The local driver reloads local Caddy, and the Docker driver reloads Caddy inside the container
+
+## Related commands
+
+- [`nb proxy caddy generate`](./generate.md)
+- [`nb proxy caddy start`](./start.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/restart.md

@@ -0,0 +1,32 @@
+---
+title: "nb proxy caddy restart"
+description: "nb proxy caddy restart command reference: restart the Caddy proxy with the current driver."
+keywords: "nb proxy caddy restart,NocoBase CLI,caddy,restart"
+---
+
+# nb proxy caddy restart
+
+Restart the Caddy proxy with the current driver.
+
+## Usage
+
+```bash
+nb proxy caddy restart
+```
+
+## Examples
+
+```bash
+nb proxy caddy restart
+```
+
+## Notes
+
+- This command stops the proxy first and then starts it again
+- With `local` or `docker`, it operates on the local process or Docker container for the current driver
+
+## Related commands
+
+- [`nb proxy caddy start`](./start.md)
+- [`nb proxy caddy stop`](./stop.md)
+- [`nb proxy caddy reload`](./reload.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/start.md

@@ -0,0 +1,32 @@
+---
+title: "nb proxy caddy start"
+description: "nb proxy caddy start command reference: start the Caddy proxy with the current driver."
+keywords: "nb proxy caddy start,NocoBase CLI,caddy,start"
+---
+
+# nb proxy caddy start
+
+Start the Caddy proxy with the current driver.
+
+## Usage
+
+```bash
+nb proxy caddy start
+```
+
+## Examples
+
+```bash
+nb proxy caddy start
+```
+
+## Notes
+
+- With the `local` driver, this starts the local Caddy process
+- With the `docker` driver, this starts or creates the Docker container
+- If the proxy is already running, the command reports that it is already running
+
+## Related commands
+
+- [`nb proxy caddy stop`](./stop.md)
+- [`nb proxy caddy status`](./status.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/status.md

@@ -0,0 +1,36 @@
+---
+title: "nb proxy caddy status"
+description: "nb proxy caddy status command reference: show the current Caddy proxy runtime status."
+keywords: "nb proxy caddy status,NocoBase CLI,caddy,status"
+---
+
+# nb proxy caddy status
+
+Show the current Caddy proxy runtime status.
+
+## Usage
+
+```bash
+nb proxy caddy status
+```
+
+## Output
+
+The output usually includes:
+
+- `driver`
+- `status`
+- `config`
+- `caddy` or `container`
+
+## Examples
+
+```bash
+nb proxy caddy status
+```
+
+## Related commands
+
+- [`nb proxy caddy info`](./info.md)
+- [`nb proxy caddy start`](./start.md)
+- [`nb proxy caddy stop`](./stop.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/stop.md

@@ -0,0 +1,32 @@
+---
+title: "nb proxy caddy stop"
+description: "nb proxy caddy stop command reference: stop the Caddy proxy with the current driver."
+keywords: "nb proxy caddy stop,NocoBase CLI,caddy,stop"
+---
+
+# nb proxy caddy stop
+
+Stop the Caddy proxy with the current driver.
+
+## Usage
+
+```bash
+nb proxy caddy stop
+```
+
+## Examples
+
+```bash
+nb proxy caddy stop
+```
+
+## Notes
+
+- With the `local` driver, this stops the local Caddy process
+- With the `docker` driver, this stops the proxy container
+- If the proxy is already stopped, the command reports that it is already stopped
+
+## Related commands
+
+- [`nb proxy caddy start`](./start.md)
+- [`nb proxy caddy status`](./status.md)

package/dist/ai/docs/nocobase/api/cli/proxy/caddy/use.md

@@ -0,0 +1,38 @@
+---
+title: "nb proxy caddy use"
+description: "nb proxy caddy use command reference: switch the current driver for the Caddy provider."
+keywords: "nb proxy caddy use,NocoBase CLI,caddy,driver"
+---
+
+# nb proxy caddy use
+
+Switch the current driver for the Caddy provider.
+
+## Usage
+
+```bash
+nb proxy caddy use <driver>
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `<driver>` | string | Supports `local` or `docker` |
+
+## Examples
+
+```bash
+nb proxy caddy use local
+nb proxy caddy use docker
+```
+
+## Notes
+
+- This command saves the result to `proxy.caddy-driver`
+- Later commands such as `start`, `reload`, `stop`, `status`, and `info` all use the current driver
+
+## Related commands
+
+- [`nb proxy caddy current`](./current.md)
+- [`nb proxy caddy start`](./start.md)

package/dist/ai/docs/nocobase/api/cli/proxy/index.md

@@ -0,0 +1,124 @@
+---
+title: "nb proxy"
+description: "nb proxy command-group reference: choose the Nginx or Caddy provider and manage reverse-proxy entrypoints for CLI-managed envs."
+keywords: "nb proxy,NocoBase CLI,nginx,caddy,reverse proxy,proxy configuration"
+---
+
+# nb proxy
+
+In NocoBase CLI, `nb proxy` is the unified entry point for reverse-proxy management.
+
+It separates env management from entry-layer management:
+
+- `nb env` saves and maintains application envs
+- `nb proxy` generates and manages Nginx or Caddy entrypoints for those CLI-managed envs
+
+As long as your app has already been saved as a CLI-managed env and that env is `local` or `docker`, choosing a provider subcommand is usually enough.
+
+## Usage
+
+```bash
+nb proxy <provider> <command>
+```
+
+## Command tree
+
+```bash
+nb proxy nginx use <local|docker>
+nb proxy nginx current
+nb proxy nginx generate --env <name> [--host <domain>] [--port <port>]
+nb proxy nginx start
+nb proxy nginx restart
+nb proxy nginx reload
+nb proxy nginx stop
+nb proxy nginx status
+nb proxy nginx info
+
+nb proxy caddy use <local|docker>
+nb proxy caddy current
+nb proxy caddy generate --env <name> [--host <domain>] [--port <port>]
+nb proxy caddy start
+nb proxy caddy restart
+nb proxy caddy reload
+nb proxy caddy stop
+nb proxy caddy status
+nb proxy caddy info
+```
+
+## Providers
+
+| I want to... | Go here |
+| --- | --- |
+| Keep using Nginx for sites, certificates, caching, or access control | [`nb proxy nginx`](./nginx/index.md) |
+| Get HTTPS running quickly while maintaining fewer TLS details yourself | [`nb proxy caddy`](./caddy/index.md) |
+| Adjust env settings that may affect proxy output, such as `app-port` or `app-public-path` | [`nb env update`](../env/update.md) |
+
+## Notes
+
+- `nb proxy` itself does not have standalone flags
+- Use `nb proxy nginx` or `nb proxy caddy` to generate and manage entrypoints
+- Both providers only work for managed envs whose runtime is reachable from the current machine, which means `local` or `docker`
+- Both providers support two drivers: `local` and `docker`
+- `use` saves the default driver, and `current` prints the current driver directly
+- `generate` writes or refreshes entry config files and does not automatically start the proxy process
+- `start`, `restart`, `reload`, `stop`, `status`, and `info` all operate on the current driver's runtime
+- If you change settings such as `app-port` or `app-public-path` with `nb env update`, you will usually need to rerun the matching `generate` command afterward
+- This command group does not currently work for envs that only have a remote API connection or for SSH envs
+
+## Typical workflow
+
+```bash
+# 1. Choose a provider and runtime driver
+nb proxy nginx use docker
+
+# 2. Generate the entry config for one CLI-managed env
+nb proxy nginx generate --env app1 --host app1.example.com
+
+# 3. Start the proxy
+nb proxy nginx start
+
+# 4. Inspect status and path information
+nb proxy nginx status
+nb proxy nginx info
+
+# 5. Reload after config changes
+nb proxy nginx reload
+```
+
+If you choose Caddy, replace `nginx` in the commands above with `caddy`.
+
+## Common command differences
+
+| Command | Purpose |
+| --- | --- |
+| `use` | Switch the default driver for the current provider |
+| `current` | Print the current provider driver, such as `local` or `docker` |
+| `generate` | Generate or refresh proxy entry files for one env |
+| `start` | Start the proxy with the current driver |
+| `reload` | Reload configuration without stopping the service |
+| `restart` | Stop and then start again |
+| `stop` | Stop the proxy |
+| `status` | Show runtime status |
+| `info` | Show the driver, config-file path, runtime root, upstream host, and related runtime details |
+
+## Examples
+
+```bash
+# Generate and start Nginx for one env
+nb proxy nginx use docker
+nb proxy nginx generate --env demo --host demo.local.nocobase.com
+nb proxy nginx start
+
+# Generate and start Caddy for one env
+nb proxy caddy use local
+nb proxy caddy generate --env demo --host demo.local.nocobase.com
+nb proxy caddy start
+```
+
+## Related commands
+
+- [`nb proxy nginx`](./nginx/index.md)
+- [`nb proxy caddy`](./caddy/index.md)
+- [`nb env update`](../env/update.md)
+- [`nb env info`](../env/info.md)
+- [`nb config`](../config/index.md)

package/dist/ai/docs/nocobase/api/cli/proxy/nginx/current.md

@@ -0,0 +1,33 @@
+---
+title: "nb proxy nginx current"
+description: "nb proxy nginx current command reference: print the current Nginx provider driver."
+keywords: "nb proxy nginx current,NocoBase CLI,nginx,driver"
+---
+
+# nb proxy nginx current
+
+Print the current Nginx provider driver.
+
+## Usage
+
+```bash
+nb proxy nginx current
+```
+
+## Output
+
+The command prints one value directly:
+
+- `local`
+- `docker`
+
+## Examples
+
+```bash
+nb proxy nginx current
+```
+
+## Related commands
+
+- [`nb proxy nginx use`](./use.md)
+- [`nb proxy nginx info`](./info.md)

package/dist/ai/docs/nocobase/api/cli/proxy/nginx/generate.md

@@ -0,0 +1,62 @@
+---
+title: "nb proxy nginx generate"
+description: "nb proxy nginx generate command reference: generate or refresh the Nginx config for one CLI-managed env."
+keywords: "nb proxy nginx generate,NocoBase CLI,nginx,reverse proxy,proxy configuration"
+---
+
+# nb proxy nginx generate
+
+Generate or refresh the Nginx entry config for one CLI-managed env.
+
+## Usage
+
+```bash
+nb proxy nginx generate --env <name> [--host <domain>] [--port <port>]
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `--env`, `-e` | string | CLI-managed env name to generate the config for |
+| `--host` | string | Host written into the entry config, such as `app1.example.com` |
+| `--port` | string | Listen port written into the entry config, such as `8080` |
+
+## Generated files
+
+Using env `test2` as an example, the command typically maintains these files and directories:
+
+- `NB_CLI_ROOT/.nocobase/proxy/nginx/nocobase.conf`
+- `NB_CLI_ROOT/.nocobase/proxy/nginx/snippets/`
+- `NB_CLI_ROOT/.nocobase/proxy/nginx/test2/app.conf`
+- `NB_CLI_ROOT/.nocobase/proxy/nginx/test2/public/index-v1.html`
+- `NB_CLI_ROOT/.nocobase/proxy/nginx/test2/public/index-v2.html`
+
+The generated Nginx entry covers these main capability areas:
+
+- `uploads`
+- `dist`
+- `well-known`
+- `api`
+- `ws`
+- `spa`
+
+## Examples
+
+```bash
+nb proxy nginx generate --env demo --host demo.local.nocobase.com
+nb proxy nginx generate --env demo --host demo.local.nocobase.com --port 8080
+```
+
+## Notes
+
+- `generate` only writes or refreshes config and does not automatically start Nginx
+- `app.conf` is the editable entry file, but its managed block must stay intact
+- If you change settings such as `app-port` or `app-public-path` with `nb env update`, you will usually need to rerun this command
+- Only CLI-managed `local` or `docker` envs can use this command
+
+## Related commands
+
+- [`nb proxy nginx start`](./start.md)
+- [`nb proxy nginx reload`](./reload.md)
+- [`nb env update`](../../env/update.md)

package/dist/ai/docs/nocobase/api/cli/proxy/nginx/index.md

@@ -0,0 +1,60 @@
+---
+title: "nb proxy nginx"
+description: "nb proxy nginx command-group reference: manage the Nginx provider driver, config generation, and runtime control."
+keywords: "nb proxy nginx,NocoBase CLI,nginx,reverse proxy,proxy configuration"
+---
+
+# nb proxy nginx
+
+`nb proxy nginx` is the command-group entry for the Nginx provider.
+
+If you already use Nginx to manage sites, certificates, caching, or access control, this is usually the place to start. It handles two things:
+
+- choosing how Nginx runs, which means `local` or `docker`
+- generating, starting, reloading, and inspecting the Nginx entrypoint for CLI-managed envs
+
+## Usage
+
+```bash
+nb proxy nginx <command>
+```
+
+## Subcommands
+
+| Command | Description |
+| --- | --- |
+| [`nb proxy nginx use`](./use.md) | Switch the Nginx driver |
+| [`nb proxy nginx current`](./current.md) | Print the current driver |
+| [`nb proxy nginx generate`](./generate.md) | Generate or refresh the Nginx config for one env |
+| [`nb proxy nginx start`](./start.md) | Start the Nginx proxy |
+| [`nb proxy nginx restart`](./restart.md) | Restart the Nginx proxy |
+| [`nb proxy nginx reload`](./reload.md) | Reload the Nginx config |
+| [`nb proxy nginx stop`](./stop.md) | Stop the Nginx proxy |
+| [`nb proxy nginx status`](./status.md) | Show Nginx runtime status |
+| [`nb proxy nginx info`](./info.md) | Show driver, config paths, and runtime info |
+
+## Notes
+
+- The current driver is stored in `proxy.nginx-driver`
+- The default driver is `local`
+- The local driver uses the executable pointed to by `bin.nginx`, whose default value is `nginx`
+- The Docker driver uses `nginx:latest`
+- The default Docker container name is `<docker.container-prefix>-nginx-proxy`
+- The Docker driver mounts host `NB_CLI_ROOT` into the container at `/apps`
+
+## Typical workflow
+
+```bash
+nb proxy nginx use docker
+nb proxy nginx generate --env app1 --host app1.example.com
+nb proxy nginx start
+nb proxy nginx status
+nb proxy nginx info
+```
+
+## Related commands
+
+- [`nb proxy`](../index.md)
+- [`nb proxy caddy`](../caddy/index.md)
+- [`nb env update`](../../env/update.md)
+- [`nb config`](../../config/index.md)