Skip to content

edgible gateway

Most users don’t need this — Edgible operates a managed gateway pool by default. These commands are for advanced setups where you want public traffic to enter through your own AWS account. Alias: gw.

Provision a new EC2 instance as a gateway and register it with your organization. Alias: new.

Terminal window
edgible gateway create \
--name eu-gateway \
--region eu-west-1 \
--instance-type t3.small
FlagDescription
-n, --name <name>Gateway name.
-d, --description <text>Free-form description.
-p, --profile <name>AWS profile to use. Default reads from your CLI config.
-r, --region <region>AWS region.
-t, --instance-type <type>EC2 instance type. Default t3.micro.
Terminal window
edgible gateway list
edgible gateway list --json

Alias: ls.

Tear down the EC2 instance and remove the device. Alias: rm.

Terminal window
edgible gateway delete --id <id> --force

Push the latest agent code to a gateway and restart its service.

Terminal window
edgible gateway resync --id <id>
FlagDescription
-i, --id <id>Gateway ID.
-v, --version <ver>Specific agent version to install.
--localSync from the locally-built agent (development).
--install-from-localInstall dependencies and build on the gateway.

Read or tail the gateway’s agent log.

Terminal window
edgible gateway logs --id <id> --follow --lines 200
FlagDescription
-i, --id <id>Gateway ID.
-n, --lines <n>Number of lines to show. Default 50.
-f, --followStream new lines.
-l, --level <level>Filter by level.
-c, --comprehensiveInclude stdout/stderr alongside the structured log.

Open a shell on the gateway over SSH.

Terminal window
edgible gateway ssh --id <id>

Truncate the gateway’s agent log file.

Terminal window
edgible gateway wipe-logs --id <id>