API Reference
Search…
Introduction
Get Started
About the Platform
Get Started
Account Management
Identity and Access Management
Single Sign-on (SSO)
Home
Projects
Docker Repository
Tool Repository
Bundles
Storage
Project
Details
Team
Activity
Connectivity
Data
Notifications
Samples
Flow
Base
Bench
Command-Line Interface
Installation
Authentication
Data Transfer
Config Settings
Output Format
Release History
Tutorials
Nextflow Pipeline
Instrument Run Upload
Bench ICA Python Library
Base Basics
Reference
API
Release Notes
Known Issues
Pricing
Security and Compliance
Network Settings
Resources
Powered By GitBook
Config Settings
The ICA CLI accepts configuration settings from multiple places, such as environment variables, configuration file, or passed in as command line arguments. When configuration settings are retrieved, the follow precedence is used to determine which setting to apply:
  1. 1.
    Command line options - Passed in with the command such as --access-token
  2. 2.
    Environment variables - Stored in system environment variables such as ICAV2_ACCESS_TOKEN
  3. 3.
    Custom config file - Passed in using the --config-file global command line option
  4. 4.
    Default config file - Stored by default in the ~/.icav2/config.yaml on macOS/Linux or C:\Users\USERNAME\.icav2\.config on Windows

Command Line Options

The following global flags are available in the CLI interface:
1
-t, --access-token string JWT used to call rest service
2
-h, --help help for icav2
3
-o, --output-format string output format (default "table")
4
-s, --server-url string server url to direct commands
5
-k, --x-api-key string api key used to call rest service
Copied!

Environment Variables

Environment variables provide another way to specify configuration settings. Variable names align with the command line options with the following modifications:
  • Upper cased
  • Prefix ICAV2_
  • All dashes replaced by underscore
For example, the corresponding environment variable name for the --access-token flag is ICAV2_ACCESS_TOKEN.

Config File

Upon launching icav2 for the first time, the configuration yaml file is created and the default config settings are set. Enter an alternative server URL or press enter to leave it as the default. Then enter your API Key and press enter.
After installing the CLI, open a terminal window and enter the icav2 command. This will initialize a default configuration file in the home directory at .icav2/config.yaml.
Configuration settings can be stored in a custom configuration file or in the default configuration file. The following settings can be placed in the config file:
1
output-format: table
2
server-url: ica.illumina.com
3
x-api-key: !!binary SMWV6dEXAMPLE
Copied!
Command-Line Interface - Previous
Data Transfer
Next - Command-Line Interface
Output Format
Last modified 4mo ago
Copy link
Contents
Command Line Options
Environment Variables
Config File