# Diagrid CLI

The Diagrid CLI allows you to manage and interact with your Catalyst resources. The CLI can perform most actions available in the Catalyst Console and provides additional utilities you can use to develop your applications using the APIs. For example, use the Diagrid CLI to:

- Create and manage apps, agents, MCP servers, components, subscriptions and more
- Invoke the Catalyst APIs and listen for incoming requests on a given app
- Connect Catalyst to your local machine to receive pubsub events, service invocations, input bindings, etc. while developing
- View workload logs

## Installing the CLI

Once you have created your Diagrid Catalyst account, you can access your organization at [https://catalyst.diagrid.io](https://diagrid.ws/get-catalyst).

Next, download and install the Diagrid CLI using the following command:

**MacOS**

```bash
curl -o- https://downloads.diagrid.io/cli/install.sh | bash
```

Move the `diagrid` binary into your path so you can run it from anywhere. For example:

```bash
sudo mv ./diagrid /usr/local/bin
```

**Linux**

```bash
curl -o- https://downloads.diagrid.io/cli/install.sh | bash
```

Move the `diagrid` binary into your path so you can run it from anywhere. For example:

```bash
sudo mv ./diagrid /usr/local/bin
```

**Windows**

:::warning

Support for the Diagrid CLI on Windows is experimental and we recommend installing it via [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) if available. The CLI on WSL2 requires https://wslutiliti.es/wslu/ to support deeper OS integration.

:::

Download the PowerShell installer

```shell
iwr -Uri https://downloads.diagrid.io/cli/install.ps1 -OutFile install.ps1
```

Execute the PowerShell installer

```
.\install.ps1
```

:::tip
You may need to temporarily set the PowerShell execution policy to `Unrestricted` to allow the installer to execute.

```shell
Set-ExecutionPolicy Unrestricted -Scope CurrentUser

.\install.ps1

Set-ExecutionPolicy Restricted -Scope CurrentUser
```

:::

Move the `diagrid.exe` executable into your path so you can run it from anywhere. For example:

```shell
Move-Item .\diagrid.exe "$($env:USERPROFILE)\bin"
```

## Using the CLI

The CLI is a static binary that should be executed from the command line. Help pages are available for you to navigate the command tree and see what flags are available on each command.

To login to Diagrid Catalyst:

```bash
diagrid login
```

The Diagrid CLI is compatible with both products: Catalyst and Dapr Ops Dashboard. If you have access to both products, you can choose which set of commands to use by specifying the product name with the command:

```
diagrid product use catalyst
```

To verify the current user identity and organization:

```bash
diagrid whoami
```

For the full command surface see the [Diagrid CLI reference](https://docs.diagrid.io/references/catalyst/catalyst-cli-intro). If something goes wrong during install or login, check the [Troubleshooting / FAQ](https://docs.diagrid.io/references/troubleshooting).