Getting started - IDYL Docs

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.

macOS
Linux
Windows

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

The install script downloads the release archive from GitHub, verifies its SHA256 checksum, and installs the idyl binary.If the installer prints a PATH note, add ~/.local/bin to your shell path and open a new terminal.

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

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 software	Deploy a workload
Store a repeatable workload definition	Use a manifest
Change running capacity	Scale a deployment
Control where workloads run	Manage a subnet
Control who can use a subnet	Control admission
Add machines to a subnet	Connect a node

​1. Install the CLI

​2. Authenticate

​3. Confirm your context

​4. Choose a workflow