Jamsocket CLI
A CLI for the Jamsocket platform
Install
You may run the Jamsocket CLI without explicitly installing it using npx jamsocket
. However, this may lead to CLI-version-related issues as NPX is not guaranteed to run the latest version and will instead use whatever version was cached with the first usage.
For this reason it is recommended that you first install the Jamsocket CLI either globally or in your project and then use npx jamsocket
. (When running npx jamsocket
from your project, the locally-installed jamsocket
will be used.) When installing the Jamsocket CLI globally, it is recommended you use a tool like Node Version Manager to manage your NodeJS binaries. NVM makes sure these binaries are installed under your user so global npm installs do not require root privileges. Once NVM is set up, run npm install jamsocket --global
.
Upgrading
npm install jamsocket@latest # to update the locally-installed Jamsocket
npm install jamsocket@latest --global # to update the global installation of Jamsocket
Authentication
Run jamsocket login
.
If you want to use the Jamsocket CLI from an automated environment (e.g. a CI/CD pipeline), you can authenticate with an access token by running jamsocket login --token [ACCESS_TOKEN]
. You can manage and generate access tokens from the Jamsocket Settings page.
Commands
jamsocket backend info BACKEND
jamsocket backend list
jamsocket backend logs BACKEND
jamsocket backend metrics BACKEND
jamsocket backend terminate BACKEND
jamsocket help [COMMAND]
jamsocket login
jamsocket logout
jamsocket logs BACKEND
jamsocket push SERVICE IMAGE
jamsocket service create NAME
jamsocket service delete NAME
jamsocket service info NAME
jamsocket service list
jamsocket spawn SERVICE
jamsocket spawn-token create SERVICE
jamsocket spawn-token revoke TOKEN
jamsocket spawn-token spawn TOKEN
jamsocket terminate BACKEND
jamsocket backend info BACKEND
Retrieves information about a backend given its name.
USAGE
$ jamsocket backend info [BACKEND]
DESCRIPTION
Retrieves information about a backend given its name.
EXAMPLES
$ jamsocket backend info a8m32q
jamsocket backend list
List running backends for the logged-in user
USAGE
$ jamsocket backend list
DESCRIPTION
List running backends for the logged-in user
EXAMPLES
$ jamsocket backend list
jamsocket backend logs BACKEND
Stream logs from a running backend.
USAGE
$ jamsocket backend logs [BACKEND]
ARGUMENTS
BACKEND The name of the backend, a random string of letters and numbers returned by the spawn command.
DESCRIPTION
Stream logs from a running backend.
ALIASES
$ jamsocket logs
EXAMPLES
$ jamsocket backend logs f7em2
jamsocket backend metrics BACKEND
Stream metrics from a running backend
USAGE
$ jamsocket backend metrics [BACKEND]
ARGUMENTS
BACKEND The name of the backend, a random string of letters and numbers returned by the spawn command.
DESCRIPTION
Stream metrics from a running backend
EXAMPLES
$ jamsocket backend metrics f7em2
jamsocket backend terminate BACKEND
Terminates a backend based on its backend name.
USAGE
$ jamsocket backend terminate [BACKEND]
DESCRIPTION
Terminates a backend based on its backend name.
ALIASES
$ jamsocket terminate
EXAMPLES
$ jamsocket backend terminate a8m32q
jamsocket help [COMMAND]
Display help for jamsocket.
USAGE
$ jamsocket help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for jamsocket.
See code: @oclif/plugin-help
jamsocket login
Authenticates user to the Jamsocket API.
USAGE
$ jamsocket login [-t <value>]
FLAGS
-t, --token=<value> for automated environments, optional API token to log into the CLI with
DESCRIPTION
Authenticates user to the Jamsocket API.
EXAMPLES
$ jamsocket login
See code: src/commands/login.ts
jamsocket logout
Logs out of Jamsocket and removes locally-stored credentials.
USAGE
$ jamsocket logout
DESCRIPTION
Logs out of Jamsocket and removes locally-stored credentials.
EXAMPLES
$ jamsocket logout
See code: src/commands/logout.ts
jamsocket logs BACKEND
Stream logs from a running backend.
USAGE
$ jamsocket logs [BACKEND]
ARGUMENTS
BACKEND The name of the backend, a random string of letters and numbers returned by the spawn command.
DESCRIPTION
Stream logs from a running backend.
ALIASES
$ jamsocket logs
EXAMPLES
$ jamsocket logs f7em2
jamsocket push SERVICE IMAGE
Pushes a docker image to the jamcr.io container registry under your logged in user's name
USAGE
$ jamsocket push [SERVICE] [IMAGE] [-t <value>]
ARGUMENTS
SERVICE Jamsocket service to push the image to
IMAGE Docker image to push
FLAGS
-t, --tag=<value> optional tag to apply to the image in the jamsocket registry
DESCRIPTION
Pushes a docker image to the jamcr.io container registry under your logged in user's name
EXAMPLES
$ jamsocket push my-service my-image
$ jamsocket push my-service my-image -t my-tag
See code: src/commands/push.ts
jamsocket service create NAME
Creates a service
USAGE
$ jamsocket service create [NAME]
DESCRIPTION
Creates a service
EXAMPLES
$ jamsocket service create my-service
jamsocket service delete NAME
Deletes a service
USAGE
$ jamsocket service delete [NAME]
DESCRIPTION
Deletes a service
EXAMPLES
$ jamsocket service delete my-service
jamsocket service info NAME
Gets some information about a service
USAGE
$ jamsocket service info [NAME]
DESCRIPTION
Gets some information about a service
EXAMPLES
$ jamsocket service info my-service
jamsocket service list
List services for the logged-in user
USAGE
$ jamsocket service list
DESCRIPTION
List services for the logged-in user
EXAMPLES
$ jamsocket service list
jamsocket spawn SERVICE
Spawns a session-lived application backend from the provided docker image
USAGE
$ jamsocket spawn [SERVICE] [-e <value>] [-g <value>] [-t <value>] [-r]
FLAGS
-e, --env=<value>... optional environment variables to pass to the container
-g, --grace=<value> optional grace period (in seconds) to wait after last connection is closed before shutting
down container
-r, --require-bearer-token require a bearer token to access the service. A random bearer token will be generated and
returned in the result.
-t, --tag=<value> optional tag for the service to spawn (default is latest)
DESCRIPTION
Spawns a session-lived application backend from the provided docker image
EXAMPLES
$ jamsocket spawn my-service
$ jamsocket spawn my-service -e SOME_ENV_VAR=foo -e ANOTHER_ENV_VAR=bar
$ jamsocket spawn my-service -g 60
$ jamsocket spawn my-service -t latest
See code: src/commands/spawn.ts
jamsocket spawn-token create SERVICE
Generate a token that can be used to spawn the given service.
USAGE
$ jamsocket spawn-token create [SERVICE] [-g <value>] [-t <value>]
FLAGS
-g, --grace=<value> optional grace period (in seconds) to wait after last connection is closed before shutting down
container
-t, --tag=<value> optional tag for the service to spawn (default is latest)
DESCRIPTION
Generate a token that can be used to spawn the given service.
EXAMPLES
$ jamsocket spawn-token create my-service
$ jamsocket spawn-token create my-service --tag latest --grace 300
jamsocket spawn-token revoke TOKEN
Revoke a spawn token permanently.
USAGE
$ jamsocket spawn-token revoke [TOKEN]
DESCRIPTION
Revoke a spawn token permanently.
EXAMPLES
$ jamsocket spawn-token revoke jNCuGvecEEk706SDm2xYRJc7mqplE2
jamsocket spawn-token spawn TOKEN
Spawn a backend using a spawn token.
USAGE
$ jamsocket spawn-token spawn [TOKEN]
DESCRIPTION
Spawn a backend using a spawn token.
EXAMPLES
$ jamsocket spawn-token spawn jNCuGvecEEk706SDm2xYRJc7mqplE2
jamsocket terminate BACKEND
Terminates a backend based on its backend name.