ChartIQ SDK Documentation

Namespace: CLI

CIQ. CLI

Command Line Interface plugin.

Type Definitions

Registry

A collection of commands for the CLI.

Properties:

Name	Type	Description
`cmdlist`	CIQ.CLI~SingleRegistryItem
`customer`	CIQ.CLI~SingleRegistryItem
`export`	CIQ.CLI~SingleRegistryItem
`help`	CIQ.CLI~SingleRegistryItem
`home`	CIQ.CLI~SingleRegistryItem
`info`	CIQ.CLI~SingleRegistryItem
`layout`	CIQ.CLI~SingleRegistryItem
`periodicity`	CIQ.CLI~SingleRegistryItem
`polling`	CIQ.CLI~SingleRegistryItem
`preferences`	CIQ.CLI~SingleRegistryItem
`range`	CIQ.CLI~SingleRegistryItem
`reset`	CIQ.CLI~SingleRegistryItem
`series`	CIQ.CLI~SingleRegistryItem
`study`	CIQ.CLI~SingleRegistryItem
`symbol`	CIQ.CLI~SingleRegistryItem
`type`	CIQ.CLI~SingleRegistryItem
`version`	CIQ.CLI~SingleRegistryItem

SingleRegistryItem

CLI command registry entry type

Type:

Object

Properties:

Name	Type	Argument	Description
`func`	function		The function to execute for the command.
`man`	string	<optional>	The cmd documentation, "manpage"
`opts`	string	<optional>	Command line options for the command. Use a colon to indicate an option that requires a value.
`usage`	string	<optional>	Usage string for the command.

Example

{
  func: function func() {
    if (func.opts.e) {
      this.echo("Example option");
    }
    this.echo("Example command");
  },
  man: "Example command description",
  opts: "e",
  usage: "example [-e]"
}