@tracktile/cli v0.40.12

Tracktile CLI

Installation

This is not yet published as a separate package and currently resides within our backend only. If you have the backend, you have this tool installed.

Usage

> tt --help

Usage: tracktile [options] [command]

Your token is expected to be provided via the TRACKTILE_TOKEN environment variable.

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  auth            Identity Management
  locations       List & Manage Inventory Locations
  help [command]  display help for command

Getting Started

Setup & Authentication

Token

The CLI requires a valid Tracktile API token to operate and expacts that token to be provided via the TRACKTILE_TOKEN environment variable or via the global --token option.

Endpoint

The CLI defaults to the https://api.tracktile.io endpoint, but you can override this via the global --endpoint option.

Output

The CLI can output in json, csv, or a human readable table format. The default is json but this can be changed via the global --output option.

Ex. --output=table will output in csv format.

> tt --output=table auth identity
┌──────────────────────────────────────┬──────────┬────────┐
│ id                                   │ type     │ name   │
├──────────────────────────────────────┼──────────┼────────┤
│ 57cf9a81-1054-4bf1-8a3e-41304ff1b9f1 │ apiToken │ jarred │
└──────────────────────────────────────┴──────────┴────────┘

Authentication

Checking Identity

You can check the identity of the currently authenticated session at any time.

> tt auth identity

{
  id: '57cf9a81-1054-4bf1-8a3e-41304ff1b9f1',
  type: 'apiToken',
  name: 'jarred'
}

Commands

Auth

Usage: tracktile auth [options] [command]

Identity Management

Options:
  -h, --help      display help for command

Commands:
  identity        Returns information about the facility connected to your current TRACKTILE_TOKEN
  help [command]  display help for command

Locations

Usage: tracktile locations [options] [command]

List & Manage Inventory Locations

Options:
  -h, --help      display help for command

Commands:
  list            Lists all stages in your flow including their containers and bundles.
  help [command]  display help for command