diff --git a/docs/cli/SUMMARY.md b/docs/cli/SUMMARY.md index 53fd90c7d..07bd2f2bb 100644 --- a/docs/cli/SUMMARY.md +++ b/docs/cli/SUMMARY.md @@ -17,4 +17,7 @@ - [Troubleshooting](guides/ms-troubleshooting.md) - Beam CLI Commands - [Commands Overview](commands/cli-command-reference.md) - - [Commands Reference](commands/cli-command-reference/) \ No newline at end of file + - [Commands Reference](commands/cli-command-reference/) +- Local Backend Development + - [Getting Started](local/getting-started.md) + - [Local Commands](local/local-commands.md) \ No newline at end of file diff --git a/docs/cli/commands/cli-command-reference.md b/docs/cli/commands/cli-command-reference.md index 1ef0679f3..83974c2bb 100644 --- a/docs/cli/commands/cli-command-reference.md +++ b/docs/cli/commands/cli-command-reference.md @@ -8,3 +8,17 @@ All of the Beam CLI commands are available in the left navigation bar. This tabl | [Config](cli-command-reference/config/config.md) | `beam config` helps you verify your current Beamable project in the CLI | | [Login](cli-command-reference/login.md) | `beam login` helps you manage access tokens for use in the CLI | | [Project](cli-command-reference/project/project.md) | `beam project` helps you create and use Standalone Microservices | +| [Local](cli-command-reference/local/local.md) | `beam local` manages local backend development environment | + +## Local Backend Development + +The `beam local` command suite provides tools for running and managing the Beamable backend locally. This enables faster development cycles by running backend services on your development machine. + +Key local development commands: +- `beam local run` - Start local backend services +- `beam local ps` - View running service status +- `beam local stop` - Stop running services +- `beam local logs` - View service logs +- `beam local validate` - Check system dependencies + +See the [Local Commands Reference](cli-command-reference/local/) for complete details. \ No newline at end of file diff --git a/docs/cli/commands/cli-command-reference/SUMMARY.md b/docs/cli/commands/cli-command-reference/SUMMARY.md index 4b5e4dbf0..9dbf3b068 100644 --- a/docs/cli/commands/cli-command-reference/SUMMARY.md +++ b/docs/cli/commands/cli-command-reference/SUMMARY.md @@ -55,6 +55,17 @@ - listen - [player](listen/player.md) - [server](listen/server.md) +- local + - [audit-realm-config](local/audit-realm-config.md) + - [compile](local/compile.md) + - [inspect](local/inspect.md) + - [list-tools](local/list-tools.md) + - [logs](local/logs.md) + - [ps](local/ps.md) + - [run](local/run.md) + - [set-local-vars](local/set-local-vars.md) + - [stop](local/stop.md) + - [validate](local/validate.md) - [login](login.md) - [logout](logout.md) - [me](me.md) @@ -123,4 +134,4 @@ - [logs](temp/clear/logs.md) - [version](version/version.md) - [install](version/install.md) - - [list](version/list.md) + - [list](version/list.md) \ No newline at end of file