Cordium documentation · Latest

Access Methods

On this page +

Every Cordium Workspace can be accessed in several ways, and all of them go through the same Octelium identity, authentication and authorization model. Here is an overview:

MethodUse it forRequirements
Web portalCreating and managing Workspaces, Spaces and Templates, browser terminals, logs, snapshots, the Cordium Agent.A web browser.
CLIDay-to-day Workspace management, interactive terminals, exec, logs and scripting.The cordium CLI.
SSHPort forwarding, SFTP/SCP, rsync, and remote development with VS Code, Zed, JetBrains and any SSH client.The cordium CLI and octelium connect.
APIs and SDKsProgrammatic sandboxes for AI agents, CI pipelines and internal platforms.The Go, Python, Rust or TypeScript SDK.
ApplicationsAccessing web applications and APIs served from inside a Workspace.A web browser or an HTTP client.
Cordium AgentManaging your Workspaces by chatting with an AI agent.A web browser.

Web Portal

The Cordium web portal is a browser-based interface for creating, managing and using Workspaces without installing any software. It is available at https://cordium.<DOMAIN> and it authenticates HUMAN Users through the Cluster's identity providers, including GitHub OAuth2 or any OpenID Connect or SAML 2.0 IdP (read more here), as well as passkeys and other Authenticators.

From the portal, you can create and configure Workspaces, Spaces, Templates, Secrets, Volumes and UserSecrets, follow a Workspace's initialization in real time, open as many browser terminals as you want inside running Workspaces, read their logs, take and restore snapshots, share their applications with your teammates, browse the Octelium Services you can access, and chat with the Cordium Agent.

cordium.example.com/workspaces/create
Creating a Workspace from the web portal and following its initialization logs until it is running

Create a Workspace and follow its initialization live.

note

Read the complete guide to the web portal here.

CLI

The cordium CLI is the primary tool for day-to-day Workspace management from a terminal. It provides access to the full Cordium API with a command structure designed around common workflows. Here are some examples:

export OCTELIUM_DOMAIN=<DOMAIN> # Create a Workspace and open an interactive terminal inside it cordium run --template api-dev.payments.cordium # Run a command inside a running Workspace cordium exec abc -- make test # Stream a Workspace's initialization logs cordium logs abc # List your Workspaces cordium get ws
note

Read the complete CLI guide here.

SSH

Cordium provides standard, secretless SSH access to running Workspaces via a dedicated SSH Octelium Service that is implemented by an identity-aware proxy in the Cluster. Workspaces do not use SSH keys or passwords at all: you authenticate with your Octelium identity and the Cluster only lets you in if you own the Workspace. Since SSH access requires you to be connected to the Cluster, you first need to run octelium connect:

octelium connect -d # Open a shell or run a command over SSH cordium ssh abc cordium ssh abc -- uptime # Copy files to, from and between Workspaces cordium cp ./dataset.parquet abc:/workspace/data/ # Generate an OpenSSH config block for VS Code, Zed, rsync, scp, etc... cordium ssh abc --print-config >> ~/.ssh/config
note

Read in detail about SSH access, port forwarding and IDE integration here.

APIs and SDKs

The complete Cordium API is exposed over gRPC. This is the interface used by the cordium CLI and the web portal. Cordium provides official SDKs for Go, Python, Rust and TypeScript/JavaScript that handle authentication, Workspace lifecycle operations, command execution, file transfers, terminals, logs, snapshots and Volumes. Here is a short Python example:

from cordium import Cordium with Cordium() as client: workspace = client.workspaces.run(image="python:3.13-slim", ephemeral=True) try: result = workspace.exec("python -c 'print(6 * 7)'", check=True) print(result.stdout) finally: workspace.delete()
note

Read the dedicated APIs and SDKs guide here.

Applications

Applications are named ports inside a Workspace that are served over HTTPS by the Cordium portal, which makes development servers, notebooks, dashboards and APIs running inside your Workspace reachable from your browser without any port forwarding (read more about configuring applications here). Each running Workspace application is reachable at a subdomain of the portal domain:

URLWhat it serves
https://<WORKSPACE>.cordium.<DOMAIN>The default application (i.e. the one with isDefault: true).
https://<APPLICATION>_<WORKSPACE>.cordium.<DOMAIN>A named application (e.g. https://api_abc.cordium.example.com).
https://port_<PORT>_<WORKSPACE>.cordium.<DOMAIN>Any port, even if it is not declared as an application (e.g. https://port_5173_abc.cordium.example.com).

By default, only the Workspace's owner can access its applications. Named applications can be shared with the members of the Workspace's Space or with all the Cluster's Users from the portal or via the API (read more here).

note

Workspaces in Regions other than default are served at <WORKSPACE>.<REGION>.cordium.<DOMAIN>. You can always find a running Workspace's hostname in its status.hostname field (e.g. via cordium get ws <WORKSPACE> -o yaml) and in the CORDIUM_HOSTNAME environment variable inside it.

Cordium Agent

The Cordium Agent is an AI agent that is built into the web portal at https://cordium.<DOMAIN>/agent. It runs inside your own Workspace, with your own identity, and it can create and manage your Workspaces, run commands and test suites inside them, copy files between them, and use the Octelium Services you are authorized to access, while you approve the sensitive operations from the chat (read more here).