Quick Start

Quick Start

1. Log in to the CLI

To use the CLI, log into your Code Capsules account

codecaps login -e <your email>

You will be prompted for your password. For security reasons, it is not recommended to provide your password inline, but is supported via the -p or --password flag:

codecaps login -e <your email> -p <your password>

Once logged in, you can ensure you are logged into the correct account using the whoami command

codecaps whoami

2. Proxy a Capsule to your local machine

Using the CLI, you can access any Capsule through a secure connection without exposing it publicly. For example, Redis Capsules cannot be accessed through a public domain. The proxy command allows you to access your Capsule by creating a safe tunnel between your local machine and the Capsule.

The proxy command is used as follows:

codecaps proxy capsule -s <space slug> -c <capsule id> -P <local port>

You won't need to memorize your Space slug or Capsule id to run the command. Instead, just head over to your Capsule details page on Code Capsules and copy the provided proxy command.

For example, for a Redis Capsule with id abc-123 in a Space with slug space-123, the command to proxy this capsule would be:

codecaps proxy capsule -s space-123 -c abc-123 -P 6379

The Redis capsule then becomes available locally on port 6379, which can be accessed using:

redis-cli -u "redis://localhost:6379"

The above example is extensible to any of our available Capsule types.

Note: any local port can be supplied using the -P <port> flag. If the flag is not provided, a random port will be used.

You can view the full list of available commands here.