Command Index
Use the following usage syntax when using the command-line interface:
$ ica infinium [command] [required parameters] [optional parameters]
help
Provides help for any command in the application.
Usage:
ica help [command] [flags]
ica config
Sets the configuration specifications in the config.yaml file.
Usage:
ica config [flags]
ica config [command]
|
Command |
Description |
|
get |
Get configuration information. |
|
set |
Set configuration information. |
infinium
The root command for actions that act on Infinium arrays resources.
Usage:
ica infinium [flags]
|
Command |
Description |
|
beadchips |
BeadChip actions. |
|
products |
Product actions. |
|
Flags |
Description |
|
-h --help |
Help for the infinium command. |
infinium beadchips
The root command for actions that act on BeadChips.
Usage:
ica infinium beadchips [flags]
ica infinium beadchips [command]
|
Command |
Description |
|
create |
Accession a BeadChip. |
|
get |
Retrieve an existing BeadChip. |
|
list |
List the existing BeadChip. |
|
Flags |
Description |
|
-h --help |
Help for BeadChips. |
infinium beadchips create
Accession a BeadChip.
Usage:
ica infinium beadchips create [local path to beadchip directory] [local path to success directory] [local path to failure directory] [flags]
|
Flags |
Description |
|
-h --help |
Help for BeadChips. |
|
--log-file string |
Log file. Default is create_beadchips.log. |
infinium products
The root command for actions that act on products.
Usage:
ica infinium products [flags]
ica infinium products [command]
|
Command |
Description |
|
create |
Create a new product in ICA. |
|
get |
Retrieve product information. |
|
list |
List existing products. |
|
Flags |
Description |
|
-h --help |
Help for infinium manifests upload. |
infinium products create
Creates a new product in ICA. Command requires the local path to a product description in XML format.
Usage:
ica infinium products create [local path to product definition file] [flags]
|
Flags |
Description |
|
-h --help |
Help for infinium manifests upload. |
infinium products get
Retrieve information on a product. Command requires product ID provided by products list command as input. Command returns the product name, number of samples, part number, revision number, and time created.
Usage:
ica infinium products get [product id] [flags]
infinium products list
List existing products added to ICA. Command returns the product ID, product name, revision number, part number, and time created.
Usage:
ica infinium products list [flags]
|
Flags |
Description |
|
-h --help |
Help for the infinium analysisfiles get command. |
|
--maxitems int |
Maximum number of items to return. Use 0 for no limit. Default is 50. |
|
--page-size int32 |
Optimizes listing operations by limiting the number of items retrieved with each API call. Default is 1000. |
|
--page-token string |
Page token used for retrieving paged list results. |
|
--part-number string |
Product part number. |
|
--revision string |
Product revision. |
|
--sort-by string |
Specifies the order to list items. Default is timeCreated Desc. |
login
Logs user into CLI and starts session.
Usage:
ica login [username] [flags]
|
Flags |
Description |
|
--api-key string |
API key for authentication |
|
--auth-url string |
Single sign-on authentication server address. Default is login.illumina.com. |
|
-d, --domain string |
Optionally pass the domain name you are logging into. |
|
-h --help |
Help for the login command. |
|
--local-port int |
Local port for single sign-on authentication flow. Default is 8282. |
|
--session-token string |
Session token for authentication. |
|
--sso |
Use single sign-on. |
|
--workgroup-id string |
Workgroup ID to set current workgroup context. |
|
--workgroup-name string |
Workgroup name to set current workgroup context. |
version
Get version of ICA.
Usage:
ica version [flags]
|
Flags |
Description |
|
-h --help |
Help for the logout command. |
