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

# CLI

The Intuned CLI (`@intuned/cli`) is a command-line tool for developing, testing, deploying, and managing Intuned automation projects. It supports TypeScript and Python, and lets you manage deployed Projects, Runs, Jobs, and Auth Sessions from the terminal.

## Installation

Install the Intuned CLI globally with npm:

```bash theme={null}
npm install -g @intuned/cli
```

Verify the installation:

```bash theme={null}
intuned -v
```

<Note>Requires Node.js and npm.</Note>

## Authentication

The CLI supports two authentication methods:

1. **Browser-based login** — Run `intuned auth login` to authenticate via browser-based OAuth. Credentials are stored locally and reused across sessions.

2. **API key** — Set the `INTUNED_API_KEY` environment variable. Requires a workspace ID from the `INTUNED_WORKSPACE_ID` environment variable or `workspaceId` in your settings file.

If both are set, the API key takes priority.

<Tip>Use API key authentication for CI/CD pipelines and automated workflows.</Tip>

For full details on authentication methods and credentials storage, see [CLI configuration reference](/main/05-references/cli/configuration).

## Configuration

### Settings file

The CLI reads project settings from a file in the root of your project directory. Supported formats (checked in order):

* `Intuned.json`
* `Intuned.jsonc`
* `Intuned.yaml` / `Intuned.yml`
* `Intuned.toml`

The settings file contains configurations used for development and deployment. For the full schema, see [Intuned.json reference](/main/05-references/intuned-json).

### Environment variables

Key environment variables for CLI configuration:

| Variable                | Description                                                                               |
| ----------------------- | ----------------------------------------------------------------------------------------- |
| `INTUNED_API_KEY`       | API key for authentication. Takes priority over browser-based login.                      |
| `INTUNED_WORKSPACE_ID`  | Workspace ID. Required when using API key authentication if not set in the settings file. |
| `INTUNED_CHROMIUM_PATH` | Path to a custom Chromium executable for the dev browser.                                 |

For the full list of environment variables, see [CLI configuration reference](/main/05-references/cli/configuration).

<Info>These are CLI configuration variables. For project-level environment variables and secrets used in your automations, see [Environment variables and secrets](/main/02-features/environment-variables-secrets).</Info>

## Key capabilities

### Local development

The `intuned dev` command group provides tools for developing and testing automations locally—run APIs, manage auth sessions, generate traces for debugging, and deploy your project when it's ready.

See [Local development](/main/02-features/local-development-cli) for a complete walkthrough.

<Tip>Make sure you install your project's dependencies before running development commands.</Tip>

### Platform management

The `intuned platform` command group lets you manage projects on the Intuned platform. You can view and start Runs and Jobs, manage Auth Sessions and Environment Variables, and more.

See [Platform reference](/main/05-references/cli/platform) for available commands.

### Project scaffolding

Create a new Intuned project with a template:

```bash theme={null}
intuned dev init
```

This walks you through selecting a language, choosing a template, naming your project, and connecting to your workspace. See [Local development](/main/02-features/local-development-cli#create-a-project) for details.

## Related resources

<CardGroup cols={2}>
  <Card title="Local development" icon="code" href="/main/02-features/local-development-cli">
    Complete guide to local development workflow
  </Card>

  <Card title="CLI reference" icon="terminal" href="/main/05-references/cli/overview">
    Full command reference and usage details
  </Card>

  <Card title="CLI configuration" icon="gear" href="/main/05-references/cli/configuration">
    Settings files, environment variables, and authentication
  </Card>

  <Card title="Quickstart" icon="rocket" href="/main/00-getting-started/quickstarts/scraper">
    Build your first automation
  </Card>

  <Card title="Intuned.json reference" icon="file-code" href="/main/05-references/intuned-json">
    Full settings file schema and options
  </Card>
</CardGroup>