> ## Documentation Index
> Fetch the complete documentation index at: https://docs.idyl.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting started

> Install the CLI, authenticate, confirm your context, and choose a workflow.

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.

<Tabs>
  <Tab title="macOS">
    Add the IDYL Homebrew tap, then install the CLI:

    ```bash theme={null}
    brew tap idyl-labs/tap
    brew install --cask idyl-labs/tap/idyl
    ```

    You can also use the install script:

    ```bash theme={null}
    curl -fsSL https://raw.githubusercontent.com/idyl-labs/cli/main/install.sh | sh
    ```
  </Tab>

  <Tab title="Linux">
    Install with the install script:

    ```bash theme={null}
    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.
  </Tab>

  <Tab title="Windows">
    Add the IDYL Scoop bucket, then install the CLI:

    ```powershell theme={null}
    scoop bucket add idyl https://github.com/idyl-labs/scoop-bucket
    scoop install idyl
    ```
  </Tab>
</Tabs>

Verify the installation:

```bash theme={null}
idyl version
```

## 2. Authenticate

Authenticate and check the current account, namespace, and subnet:

```bash theme={null}
idyl login
idyl whoami
```

## 3. Confirm your context

If the context is wrong, change it before following a guide:

```bash theme={null}
idyl context edit --set-subnet <subnet>
idyl context edit --set-namespace <namespace>
```

## 4. Choose a workflow

<Columns cols={2}>
  <Card title="Deploy a workload" href="/build/deploy-a-workload">
    Create a deployment or job from a container image, then verify it.
  </Card>

  <Card title="Operate a subnet" href="/operate/manage-a-subnet">
    Create a subnet, set its admission rules, and inspect capacity.
  </Card>

  <Card title="Provide capacity" href="/provide/connect-a-node">
    Initialize a node, start it, and confirm it appears in a subnet.
  </Card>

  <Card title="Use the CLI" href="/cli">
    Learn CLI configuration, command structure, and exact command syntax.
  </Card>
</Columns>

## Choose by role

| If you want to...                      | Start here                                      |
| -------------------------------------- | ----------------------------------------------- |
| Run software                           | [Deploy a workload](/build/deploy-a-workload)   |
| Store a repeatable workload definition | [Use a manifest](/build/use-a-manifest)         |
| Change running capacity                | [Scale a deployment](/build/scale-a-deployment) |
| Control where workloads run            | [Manage a subnet](/operate/manage-a-subnet)     |
| Control who can use a subnet           | [Control admission](/operate/control-admission) |
| Add machines to a subnet               | [Connect a node](/provide/connect-a-node)       |