Skip to content

Docs: cli beam local commands #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cdhanna wants to merge 3 commits into from
Closed

Docs: cli beam local commands #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26f2720
docs: update for source PR #4258
cdhanna Mar 19, 2026
6377ec4
docs: update for source PR #4258
cdhanna Mar 19, 2026
f3ee604
docs: update for source PR #4258
cdhanna Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/cli/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
- [Commands Reference](commands/cli-command-reference/)
- Local Backend Development
- [Getting Started](local/getting-started.md)
- [Local Commands](local/local-commands.md)
14 changes: 14 additions & 0 deletions docs/cli/commands/cli-command-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 12 additions & 1 deletion docs/cli/commands/cli-command-reference/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)