Skip to main content

Settings file

The CLI reads project settings from a settings file in the root of your project directory. The following file names are supported (checked in order):
  • Intuned.json
  • Intuned.jsonc
  • Intuned.yaml / Intuned.yml
  • Intuned.toml
You can use the --settings-format option on supported commands to specify the format when creating or modifying the settings file. For the full settings file schema (including the defaults block for proxy, timeouts, traces, retries, and auth session behavior), see Intuned.json reference.

Environment variables

VariableDescription
INTUNED_API_KEYAPI key for authentication. When set, takes priority over browser-based login. Requires INTUNED_WORKSPACE_ID or workspaceId in settings.
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.
INTUNED_STEALTH_CHROMIUM_PATHPath to a Chromium executable used for stealth mode.
INTUNED_SETTINGS_PATHDirectory for CLI settings and credentials. Defaults to ~/.intuned.
INTUNED_EXTENSION_PATHPath to the captcha solver browser extension.
INTUNED_CAPTCHA_EXTENSION_PORTPort for the captcha solver extension to communicate on.

Authentication

The CLI supports two authentication methods, resolved in the following priority order:
  1. API key (INTUNED_API_KEY environment variable) — authenticates using an API key. Requires INTUNED_WORKSPACE_ID or workspaceId in the settings file. The API key is exchanged for a short-lived token that is cached and auto-refreshed.
  2. Browser-based login (intuned login) — interactive browser-based OAuth login. Credentials are stored in ~/.intuned/credentials.json and auto-refreshed.
If neither method is configured, the CLI returns an authentication error.

Credentials storage

Browser-based login credentials are stored in:
~/.intuned/credentials.json
This file is managed automatically by intuned login and intuned logout. Tokens are auto-refreshed when they expire.

Reference