mereacre / nqm-tdx-console

nqm-tdx-console

nqm-tdx-api-client

Nquiringminds TDX API client application

Install

The best use of tdxcli tool is to install it with npm globally as follows:

npm i -g nqm-tdx-api-client

The client app can be accessed by running the command tdxcli.

Usage

Usage: tdxcli <command> [options]

Commands:
  tdxcli signin [id] [secret]                   Sign in to tdx
  tdxcli signout                                Sign out of tdx
  tdxcli info [type] [id]                       Output current account info
  tdxcli config                                 Output tdx config
  tdxcli list                                   List all configured aliases
  tdxcli runapi <command>                       Run a tdx api command
  tdxcli download <id> [filepath]               Download resource
  tdxcli upload <id> <filepath>                 Upload resource
  tdxcli copyalias <aliasname>                  Makes a copy of an existing alias configuration
  tdxcli modifyalias <aliasname> <configjson>   Modifies an existing alias configuration
  tdxcli removealias <aliasname>                Removes an existing alias configuration
  tdxcli abortdatabot <instanceid>              Aborts a databot instance
  tdxcli stopdatabot <instanceid>               Stops a databot instance
  tdxcli startdatabot <databotid> <configjson>  Starts a databot instance

Options:
  -a, --alias    Alias name                                                                   [string]
  -h, --help     Show help                                                                   [boolean]
  -v, --version  Show version number                                                         [boolean]

Documentation

In order to use the tdxcli app one has to sign into a tdx account with an email address or share token (id and secret). If the user signs in using an email address the tdxcli will automatically open a Chromium browser window where the user can input the credentials. If the user signs in with an email id + secret the tdxcli app will open a headless Chromium window and will automatically fill in the credentials. Finally, if the user signs in with a share token the tdxcli will sign in using the tdx api authentication method.

signin

Usage

tdxcli signin
tdxcli signin emailorsharetokenid thesecret

The first command will open a Chromium browser window, wheares the second will do an automatic signin with the provided credentials. The obtained access token will be stored in the .env file.

Initially the user has to choose an alias in order to sign into a given tdx account. The default aliases are nqminds and nq_m, which correspond to tdx.nqminds.com and tdx.nq_m.com, respectively .

tdxcli signin --alias=nqminds
tdxcli signin emailorsharetokenid thesecret --alias=nq_m

The aliases configurations are stored in config.json:

  "tdxConfigs": {
    "nqminds": {
      "tokenHref": "https://tbx.nqminds.com",
      "config": {
        "commandServer": "https://cmd.nqminds.com",
        "ddpServer": "https://ddp.nqminds.com",
        "queryServer": "https://q.nqminds.com",
        "tdxServer": "https://tdx.nqminds.com",
        "accessTokenTTL": 31622400
      }
    },
    "nq_m": {
      "tokenHref": "https://tbx.nq-m.com",
      "config": {
        "commandServer": "https://cmd.nq-m.com",
        "ddpServer": "https://ddp.nq-m.com",
        "queryServer": "https://q.nq-m.com",
        "tdxServer": "https://tdx.nq-m.com",
        "accessTokenTTL": 31622400
      }
    }
  }

An new alias can be copied from an existing alias, it can be modified or removed.

The tdxcli signin allows storing access tokens and secrets for every configured alias. So, that the user can change among them by providing the tdxcli signin --alias=name option.

If the optins --alias is not provided tdxcli will use default alias name, which was obtained by previously running the command:

tdxcli signin --alias=name

Note, the sign in process will fail if using an email address with added security (for instance signing in with gmail + second factor authentication).

signout

Usage

tdxcli signout
tdxcli signout --alias=name

Sign out from the default alias or from the alias given by the name name. The command removes the stored access token and the secrets from .env file for default alias or the alias given by name name.

info

Usage

tdxcli info
tdxcli info account
tdxcli info serverfolderid appid
tdxcli info databotsid

The above command can also be run with the --alias option.

tdxcli info and tdxcli info account will output the account information corresponding to the signed in access token.

tdxcli info serverfolderid appid will return the server folder id for a given application id appid.

tdxcli info databotsid will return all databot ids.

config

Usage

tdxcli config
tdxcli config --alias=name

Outputs the current tdx config for the default or a given alias name name.

list

Usage

tdxcli list

Lists the default alias and all configured ones.

runapi

Usage

tdxcli runapi getAccounts
tdxcli runapi getData [email protected]="testa" [email protected]="testb" [email protected]=1
tdxcli runapi getData [email protected]="1" [email protected]="testb" [email protected]=1 -- @1.a

The above commands can also be run with a given --alias options.

The runapi command executes a tdx api function. The argumets of the function are encoded using --@n, where n is the index of the argument starting from 1.

For instance getData(datasetId, filter, projection, options, ndJSON) has 5 arguments. The value of each argument can be encoded as --@1=value,--@2=value,--@3=value,--@4=value,--@5=value. If the value is an object then one can use the dot notation for encoding. For instance if the getData filter equals {a: {b: {c: 1}}} then it can be encoded as [email protected]=1.

Note, the command line parser tries to identify if an argument value is a number or not. So, if you pass --@1="12345" it will translate it into the number 12345. To solves this problem one has to use the -- symbol at the end of all argument definition and write an additional [email protected] signifying that the arguiment 1 should be kept as string. Below is the usage example

tdxcli runapi apicommand [email protected]="12345" -- @1.a

download

Usage

tdxcli download resourceid
tdxcli download resourceid outputfilename

The first command will download the resource and output it to stdout. Using this command one can save the resource into a file with tdxcli download someid >> outfile or pipe it into another bash command.

The second command will save the resource into a file given by the name outputfilename.

upload

Usage

tdxcli upload resourceid filetoupload

The above command uploads the file filetoupload into a resource given by the resourceid.

copyalias

Usage

tdxcli copyalias newalias
tdxcli copyalais newalias --alias=somealais

The first command makes a copy of the default alias configuration to a newalias configuration and saves it into config.json.

The second command makes a copy of somealias configuration to a newalias configuration and saves it into config.json

modifyalias

Usage

tdxcli modifyalias aliasname configfile.json

The above command modifies the aliasname configuration using the json from configfile.json and saves it to config.json.

Example config file configfile.json:

{
  "tokenHref": "https://tbx.nqminds.com",
  "config": {
    "commandServer": "https://cmd.nqminds.com",
    "ddpServer": "https://ddp.nqminds.com",
    "queryServer": "https://q.nqminds.com",
    "tdxServer": "https://tdx.nqminds.com",
    "accessTokenTTL": 31622400
  }
}

removealias

Usage

tdxcli removealias aliasname

The removes the aliasname from config.json.

abortdatabot

Usage

tdxcli abortdatabot databotinstanceid

Aborts the databot instance id databotinstanceid.

stopdatabot

Usage

tdxcli stopdatabot databotinstanceid

Stops the databot instance id databotinstanceid.

startdatabot

Usage

tdxcli startdatabot databotid databot.json

Starts an instance of the databot id databotid with the configuration file given by the filedatabot.json.

Example databot instance start configuration file:

{
  "inputs": {
    "settings": {}
  },
  "id": "instanceid",
  "name": "somename",
  "overwriteExisting": "instanceid",
  "schedule": {
    "always": true
  },
  "shareKeyId": "someappid",
  "shareKeySecret": "somesecret",
}