Skip to main content
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: 
npm install -g @intuned/cli
Verify the installation: 
intuned -v
Requires Node.js and npm.

​
Authentication

The CLI supports two authentication methods:
  1. Browser-based login — Run intuned 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.
Use API key authentication for CI/CD pipelines and automated workflows.
For full details on authentication methods and credentials storage, see CLI configuration reference.

​
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.

​
Environment variables

Key environment variables for CLI configuration:
VariableDescription
INTUNED_API_KEYAPI key for authentication. Takes priority over browser-based login.
INTUNED_WORKSPACE_IDWorkspace ID. Required when using API key authentication if not set in the settings file.
INTUNED_CHROMIUM_PATHPath to a custom Chromium executable for the dev browser.
For the full list of environment variables, see CLI configuration reference.
These are CLI configuration variables. For project-level environment variables and secrets used in your automations, see Environment variables and secrets.

​
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 for a complete walkthrough.
Make sure you install your project’s dependencies before running development commands.

​
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 for available commands.

​
Project scaffolding

Create a new Intuned project with a template: 
intuned dev init
This walks you through selecting a language, choosing a template, naming your project, and connecting to your workspace. See Local development for details.

Local development

Complete guide to local development workflow

CLI reference

Full command reference and usage details

CLI configuration

Settings files, environment variables, and authentication

Quickstart

Build your first automation

Intuned.json reference

Full settings file schema and options