Skip to main content
The Intuned CLI is part of the Intuned Runtime SDK and provides command-line access to develop and deploy Intuned Typescript projects. When the Runtime SDK is installed, the CLI becomes available in your project.

​
Commands

​
Run API

Executes an API Run. 
yarn intuned run api <api_name> <parameters> [options]
​
<api_name>
string
required
Name of the API to run. APIs are under api directory, without the file extension. If the API is in a nested directory, / is used to separate the directories.
​
<parameters>
string
required
Parameters to pass to the API. Accepts a JSON string or a path to a JSON file.
Options 
    --retries <number>                      
    --proxy <url>                           
    --timeout <time>                        
    --headless                              
    -o, --output-file <path>                
    -a, --auth-session <id>                 
    --no-auth-session-auto-recreate         
    --auth-session-check-attempts <number>  
    --auth-session-create-attempts <number> 
    -h, --help
​
--retries
int
default:"1"
Number of retries for the API if an error in the API execution occurs.
​
--proxy
path
Proxy URL to use for the browser.
​
--headless
Run the browser in headless mode. By default, the browser runs in headful mode.
​
--timeout
timeout
default:"10 mins"
Timeout for an attempt. Check out timeout format for more information.
​
--output-file
string
Path to save the output of the run. The output is a JSON object that contains the result of the API and extended payloads (if applicable).
​
-a, --auth-session
string
Auth session ID to use for the run. The auth session files are expected to be in ./auth-session-instances/<id>.Must be provided if auth sessions are enabled in Intuned.json. Ignored if not.
​
--no-auth-session-auto-recreate
Disable auto recreate for auth session. By default, the auth session will be auto-recreated if initial check fails.Only applicable if auth sessions are enabled in Intuned.json.
​
--auth-session-check-attempts
int
default:"1"
Number of attempts to check if the auth session is valid.Only applicable if auth sessions are enabled in Intuned.json.
​
--auth-session-create-attempts
int
default:"1"
Number of attempts to create the auth session if initial check fails.Only applicable if auth sessions are enabled in Intuned.json and auth session auto-recreate is enabled.
​
-h, --help
Display help for command. Will not execute the command.

​
Run Auth Session Validate

Executes an AuthSession:Validate Run. Auth sessions must be enabled in Intuned.json. 
yarn intuned run authsession validate <id> [options]
​
<id>
string
required
ID of the auth session to validate. The auth session files are expected to be in ./auth-session-instances/<id>.
Options 
    --check-attempts <number>               
    --create-attempts <number>              
    --timeout <time>                        
    --headless                              
    --proxy <url>                           
    --no-auto-recreate                      
    -h, --help
​
--check-attempts
int
default:"1"
Number of attempts to check if the auth session is valid.
​
--create-attempts
int
default:"1"
Number of attempts to create the auth session if initial check fails.Only applicable if auto-recreate is enabled.
​
--proxy
path
Proxy URL to use for the browser.
​
--headless
Run the browser in headless mode. By default, the browser runs in headful mode.
​
--timeout
timeout
default:"10 mins"
Timeout for an attempt. Check out timeout format for more information.
​
--no-auto-recreate
Disable auto recreate. By default, the auth session will be auto-recreated if initial check fails.
​
-h, --help
Display help for command. Will not execute the command.

​
Run Auth Session Create

Executes an AuthSession:Create Run. Credentials-based auth sessions must be enabled in Intuned.json. 
yarn intuned run authsession create <parameters> [options]
​
<parameters>
string
required
Parameters to pass to the auth session create. Accepts a JSON string or a path to a JSON file.
Options 
    --id <id>                                   
    --check-attempts <number>                   
    --create-attempts <number>                  
    --timeout <time>                            
    --headless                                  
    --proxy <url>                               
    -h, --help
​
--id
string
default:"auth-session-{current timestamp}"
ID of the auth session to create. The auth session files will be created in ./auth-session-instances/<id>.
​
--check-attempts
int
default:"1"
Number of attempts to check if the auth session is valid after successful create.
​
--create-attempts
int
default:"1"
Number of attempts to create the auth session.
​
--proxy
path
Proxy URL to use for the browser.
​
--headless
Run the browser in headless mode. By default, the browser runs in headful mode.
​
--timeout
timeout
default:"10 mins"
Timeout for an attempt. Check out timeout format for more information.
​
-h, --help
Display help for command. Will not execute the command.

​
Run Auth Session Update

Executes an AuthSession:Update Run. Credentials-based auth sessions must be enabled in Intuned.json. 
yarn intuned run authsession update <id> [options]
​
<id>
string
required
ID of the auth session to update. The auth session files are expected to be in ./auth-session-instances/<id>.
Options 
    --parameters <parameters>            
    --check-attempts <number>            
    --create-attempts <number>           
    --timeout <time>                     
    --headless                           
    --proxy <url>                        
    -h, --help
​
--parameters
string
Parameters to pass to the auth session create. Accepts a JSON string or a path to a JSON file. If not provided, the last used parameters will be used.
​
--check-attempts
int
default:"1"
Number of attempts to check if the auth session is valid after successful create.
​
--create-attempts
int
default:"1"
Number of attempts to create the auth session.
​
--proxy
path
Proxy URL to use for the browser.
​
--headless
Run the browser in headless mode. By default, the browser runs in headful mode.
​
--timeout
timeout
default:"10 mins"
Timeout for an attempt. Check out timeout format for more information.
​
-h, --help
Display help for command. Will not execute the command.

​
Attempt API

Executes an Intuned API Attempt. 
yarn intuned attempt api <api_name> <parameters> [options]
​
<api_name>
string
required
Name of the API to attempt. APIs under api directory, without the file extension. If the API is in a nested directory, / is used to separate the directories.
​
<parameters>
string
required
Parameters to pass to the API. Accepts a JSON string or a path to a JSON file.
Options 
    --proxy <url>                               
    --timeout <time>                            
    --headless                                  
    -o, --output-file <path>                    
    -a, --auth-session <id>                     
    -h, --help
​
--proxy
path
Proxy URL to use for the browser.
​
--headless
Run the browser in headless mode. By default, the browser runs in headful mode.
​
--timeout
timeout
default:"10 mins"
Timeout for an attempt. Check out timeout format for more information.
​
--output-file
string
Path to save the output of the attempt. The output is a JSON object that contains the result of the API and extended payloads (if applicable).
​
-a, --auth-session
string
Auth session ID to use for the attempt. The auth session files are expected to be in ./auth-session-instances/<id>.Must be provided if auth sessions are enabled in Intuned.json. Ignored if not.
​
-h, --help
Display help for command. Will not execute the command.

​
Attempt Auth Session Check

Executes an Intuned AuthSession:Check Attempt. 
yarn intuned attempt authsession check <id> [options]
Options 
    --proxy <url>                           
    --timeout <time>                        
    --headless                              
    -h, --help
​
<id>
string
required
ID of the auth session to check. The auth session files are expected to be in ./auth-session-instances/<id>.
​
--proxy
path
Proxy URL to use for the browser.
​
--headless
Run the browser in headless mode. By default, the browser runs in headful mode.
​
--timeout
timeout
default:"10 mins"
Timeout for an attempt. Check out timeout format for more information.
​
-h, --help
Display help for command. Will not execute the command.

​
Attempt Auth Session Create

Executes an Intuned AuthSession:Create Attempt. 
yarn intuned attempt authsession create <parameters> [options]
​
<parameters>
string
required
Parameters to pass to the API. Accepts a JSON string or a path to a JSON file.
Options 
    --id <id>                                       
    --proxy <url>                                   
    --timeout <time>                                
    --headless                                      
    -h, --help
​
--id
string
default:"auth-session-{current timestamp}"
ID of the auth session to create. The auth session files will be created in ./auth-session-instances/<id>.
​
--proxy
path
Proxy URL to use for the browser.
​
--headless
Run the browser in headless mode. By default, the browser runs in headful mode.
​
--timeout
timeout
default:"10 mins"
Timeout for an attempt. Check out timeout format for more information.
​
-h, --help
Display help for command. Will not execute the command.

​
Save Project

Saves the project state to the Intuned platform. 
yarn intuned save <project-name> [options]
​
<project-name>
string
Name of the project. If not provided, the name in Intuned.json will be used.
Options 
    --workspace-id <str>
    --api-key <str>
    -h, --help
​
<project-name>
string
Name of the project. If not provided, the name in Intuned.json will be used.
​
--api-key
string
API key to use for authentication. If not provided, INTUNED_API_KEY environment variable will be used.
​
-h, --help
Display help for command. Will not execute the command.

​
Deploy Project

Saves and deploy the project state to the Intuned platform. 
yarn intuned deploy <project-name> [options]
​
<project-name>
string
Name of the project. If not provided, the name in Intuned.json will be used.
Options 
    --workspace-id <str>
    --api-key <str>
    -h, --help
​
<project-name>
string
Name of the project. If not provided, the name in Intuned.json will be used.
​
--api-key
string
API key to use for authentication. If not provided, INTUNED_API_KEY environment variable will be used.
​
-h, --help
Display help for command. Will not execute the command.

​
Formats

​
Timeout Format

  • Typescript
  • Python
Number representing milliseconds or ms-formatted string.
⌘I