Get started with the CLI

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:

brew tap idyl-labs/tap
brew install --cask idyl-labs/tap/idyl

You can also use the install script:

curl -fsSL https://raw.githubusercontent.com/idyl-labs/cli/main/install.sh | sh

Install with the install script:

curl -fsSL https://raw.githubusercontent.com/idyl-labs/cli/main/install.sh | sh

Add the IDYL Scoop bucket, then install the CLI:

scoop bucket add idyl https://github.com/idyl-labs/scoop-bucket
scoop install idyl

Verify the installation:

idyl version

idyl login

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

idyl whoami

Review the active account, profile, namespace, and subnet before running commands that create or change resources.

If the active values are not the ones you want to use, update the context:

idyl context edit --set-namespace <namespace>
idyl context edit --set-subnet <subnet>

Commands that accept --namespace or --subnet can also override the saved context for one command.

Create a deployment or job from a container image.

Create or update resources from YAML.

Create, inspect, update, and delete subnets.

Add a node to a subnet.

For exact syntax, use the command reference.