Skip to content

Docs: cli beam local commands #45

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 #45

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
38ca482
docs: update for source PR #4258
cdhanna Mar 19, 2026
42db7ee
docs: update for source PR #4258
cdhanna Mar 19, 2026
587b6d5
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
4 changes: 4 additions & 0 deletions docs/cli/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
- [Logging](guides/ms-logging.md)
- [Command Line Output](guides/ms-command-line.md)
- [Troubleshooting](guides/ms-troubleshooting.md)
- Local Backend Development
- [Overview](guides/local-backend-overview.md)
- [Setup and Dependencies](guides/local-backend-setup.md)
- [Running Tools](guides/local-backend-tools.md)
- Beam CLI Commands
- [Commands Overview](commands/cli-command-reference.md)
- [Commands Reference](commands/cli-command-reference/)
15 changes: 15 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,18 @@ 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` commands for managing local backend development |

## Global Options

The following options are available for all Beam CLI commands:

### Java Path
The `--java-path` option allows you to specify a custom location for Java 8, which is required for local backend development commands.

- **Flag**: `--java-path`
- **Default**: The CLI attempts to resolve Java through common install locations
- **Environment Variable**: `BEAM_JAVA_EXE`
- **Description**: Points to the Java 8 executable needed to run backend tools and utilities

Example:
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)