Skip to main content
The fastest way to start using IDYL is with the CLI. Use idyl to authenticate, check your current account, choose a namespace and subnet, then follow the workflow you came here to complete.

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
Verify the installation:
idyl version

2. Authenticate

Authenticate and check the current account, namespace, and subnet:
idyl login
idyl whoami

3. Confirm your context

If the context is wrong, change it before following a guide:
idyl context edit --set-subnet <subnet>
idyl context edit --set-namespace <namespace>

4. Choose a workflow

Deploy a workload

Create a deployment or job from a container image, then verify it.

Operate a subnet

Create a subnet, set its admission rules, and inspect capacity.

Provide capacity

Initialize a node, start it, and confirm it appears in a subnet.

Use the CLI

Learn CLI configuration, command structure, and exact command syntax.

Choose by role

If you want to…Start here
Run softwareDeploy a workload
Store a repeatable workload definitionUse a manifest
Change running capacityScale a deployment
Control where workloads runManage a subnet
Control who can use a subnetControl admission
Add machines to a subnetConnect a node