Skip to main content
Use this page when you have IDYL access and want to start from the terminal.

1. Install the CLI

Choose the install path for your operating system.
Add the IDYL Homebrew tap, then install the CLI:
You can also use the install script:
Verify the installation:

2. Log in

The CLI authenticates your session and saves the context used by later commands.

3. Check the active context

Review the active account, profile, Namespace, optional Workspace, and Subnet before running commands that create or change resources.

4. Select a Namespace, optional Workspace, and Subnet

If the active values are not the ones you want to use, update the context:
Use idyl use <namespace>/<workspace> when file or Run commands should use a Workspace in that Namespace. See Workspaces. Commands that accept --workspace, --namespace, or --subnet can also override the saved context for one command.

5. Choose a workflow

Deploy a workload

Create a deployment or job from a container image.

Use a manifest

Create or update resources from YAML.

Manage a subnet

Create, inspect, update, and delete subnets.

Connect capacity

Add a node to a subnet.
For exact syntax, use the command reference.