beam
CLI is a command-line utility that lets you work with Beam using beam
commands, from uploading files to volumes to deploying your applications.
You can use the --help
flag to get information about any command.
beam deploy
– deploy an app to the cloudbeam shell
– SSH into a container to debug it interactivelybeam serve
– create a temporary live preview of your appbeam logs
– stream logs from a task, container, or deployment~/.beam/config.ini
. When you run beam config create
, your API keys will be saved to this file.
~/.beam/config.ini
Context Name
(required) — the name of the profile i.e. prod or staging.Gateway Host
(optional) — used only for self-hosting. If you are using the beam.cloud, you can leave this blank.Gateway Port
(optional) — used only for self-hosting. If you are using the beam.cloud, you can leave this blank.Token
(required) — your API token, found on this page of the dashboard.Gateway Host
or Gateway Port
, you
can leave both fields blank.beam deploy [...]
or beam deploy create [...]
.container_id
:
beam deployment list
.
beam task list
.
beam container list
.
.beamignore
file in your project’s root directory to tell Beam which local files and directories to ignore when syncing to Beam.
This follows the conventions of .gitignore
Ignoring Files