Connect with SSH

aircloud ssh allows you to connect to a running container from your local terminal using SSH. It is the preferred option when your workflow depends on native SSH features, such as:

scp
SSH tunneling
Port forwarding with ssh -L
VS Code Remote SSH

Unlike the Web Terminal or aircloud exec, SSH access requires a registered SSH public key.

When to Use `aircloud ssh`

Use aircloud ssh when you need to:

Transfer files using scp.
Create SSH tunnels or port forwarding.
Connect using SSH-based IDEs.
Work with an SSH-centric operational workflow.

Register an SSH Key

Open SSH Keys from the Project sidebar.

When adding a new SSH key, provide:

A descriptive name.
Your complete OpenSSH public key.
The endpoint where the key should be injected.

If the endpoint is already running when a key is added or updated, the new key is applied the next time the endpoint starts or is redeployed. Existing running containers continue using their current key set.

Apply SSH Keys to Specific Containers

Registered SSH keys can be managed independently for each endpoint.

Apply to specific endpoints — Select which endpoint should receive the SSH key during registration.
Enable or Disable — Disable a key without deleting it. Disabled keys are no longer injected after the next container restart and can be re-enabled later.

Changes to SSH key settings take effect only after the container has been stopped and started again.

Prerequisites

AirCloud Templates

Some AirCloud-provided templates, such as Jupyter environments and code workspaces, already include SSH support.

Basic Setup

1. Generate an SSH Key Pair

ssh-keygen -t ed25519 -C "your-email@example.com"

2. View Your Public Key

cat ~/.ssh/id_ed25519.pub

3. Register the Public Key

In the AirCloud Console:

Open your Project.
Navigate to SSH Keys.
Click Add SSH Key.
Select the endpoint where the key should be injected.

4. Restart the Endpoint (If Required)

If the endpoint was already running when the key was added or updated, stop and restart the endpoint to apply the new SSH key.

Connect Using `aircloud ssh`

Connect to an Endpoint

aircloud ssh <endpoint_id>

Use a Specific Identity File

aircloud ssh <endpoint_id> -i ~/.ssh/aircloud_key

Connect to a Specific Replica

aircloud ssh <endpoint_id> -r <replica_id>

Connect as a Different User

aircloud ssh <endpoint_id> -u myuser

Open a Tunnel Only

aircloud ssh <endpoint_id> --tunnel-only

Use with VS Code Remote SSH, scp, and other tools

To use external SSH tools such as VS Code Remote SSH, scp, or rsync, register a reusable SSH config entry once:

aircloud ssh-config <endpoint_id> --install -i ~/.ssh/id_ed25519

Then connect by host alias:

ssh aircloud-<endpoint_id>
scp ./file aircloud-<endpoint_id>:/workspace/
# VS Code: Remote-SSH → Connect to Host → aircloud-<endpoint_id>

To remove the entry later:

aircloud ssh-config <endpoint_id> --uninstall

`aircloud ssh` vs. `aircloud exec`

Feature	`aircloud ssh`	`aircloud exec`
Requires SSH key registration	✅ Yes	❌ No
Supports `scp`	✅ Yes	❌ No
Supports SSH tunneling	✅ Yes	❌ No
Supports Remote SSH tools	✅ Yes	❌ No
Connection speed	Slightly slower	Faster

Get started

Air API

Air Container

Reference

Console

Support

When to Use `aircloud ssh`

Register an SSH Key

Apply SSH Keys to Specific Containers

Prerequisites

AirCloud Templates

Basic Setup

1. Generate an SSH Key Pair

2. View Your Public Key

3. Register the Public Key

4. Restart the Endpoint (If Required)

Connect Using `aircloud ssh`

Connect to an Endpoint

Use a Specific Identity File

Connect to a Specific Replica

Connect as a Different User

Open a Tunnel Only

Use with VS Code Remote SSH, scp, and other tools

`aircloud ssh` vs. `aircloud exec`

​When to Use aircloud ssh

​Register an SSH Key

​Apply SSH Keys to Specific Containers

​Prerequisites

​AirCloud Templates

​Basic Setup

​1. Generate an SSH Key Pair

​2. View Your Public Key

​3. Register the Public Key

​4. Restart the Endpoint (If Required)

​Connect Using aircloud ssh

​Connect to an Endpoint

​Use a Specific Identity File

​Connect to a Specific Replica

​Connect as a Different User

​Open a Tunnel Only

​Use with VS Code Remote SSH, scp, and other tools

​aircloud ssh vs. aircloud exec

When to Use `aircloud ssh`

Register an SSH Key

Apply SSH Keys to Specific Containers

Prerequisites

AirCloud Templates

Basic Setup

1. Generate an SSH Key Pair

2. View Your Public Key

3. Register the Public Key

4. Restart the Endpoint (If Required)

Connect Using `aircloud ssh`

Connect to an Endpoint

Use a Specific Identity File

Connect to a Specific Replica

Connect as a Different User

Open a Tunnel Only

Use with VS Code Remote SSH, scp, and other tools

`aircloud ssh` vs. `aircloud exec`