@entrinsik/ir

v13.0.0-beta.4

Published

3 months ago

Informer Reporting CLI

0High
0Medium
0Low

bleupen

oclif

@entrinsik/ir-cli

Informer Reporting CLI

Usage

$ npm install -g @entrinsik/ir
$ ir COMMAND
running command...
$ ir (--version)
@entrinsik/ir/13.0.0-beta.4 darwin-arm64 node-v22.13.0
$ ir --help [COMMAND]
USAGE
  $ ir COMMAND
...

Commands

`ir chat`

Interactive chat with AI assistants using blessed UI

USAGE
  $ ir chat [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [--model <value>] [--chat <value>] [--stateless] [-a <value>...] [--fs] [--git] [--exec] [--http] [-t
    <value>...] [-s <value>] [-i <value>...] [-r] [-m <value>]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -a, --assistant=<value>...          Assistant ID to include in conversation
  -c, --config=<value>                the path to a json config file for command flags
  -i, --input=<value>...              Input file to include in initial message
  -k, --token=<value>                 authenticate with an Informer API token
  -m, --message=<value>               Single message to send (non-interactive)
  -r, --repl                          Start in REPL mode
  -s, --system=<value>                System message to set context
  -t, --tenant=<value>                the Informer tenant to connect as
  -t, --tool=<value>...               Path to custom tool file (JavaScript module)
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --chat=<value>                  Existing chat ID to continue (enables stateful mode)
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --exec                          Enable system execution tool (use with caution)
      --fs                            Enable filesystem tools (ls, read, write, mkdir, rm)
      --git                           Enable git tools (git, git-status, git-log)
      --http                          Enable HTTP tools (http-get)
      --model=<value>                 Model ID to use for the chat
      --[no-]stateless                Use stateless mode (no conversation persistence) - this is the default
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Interactive chat with AI assistants using blessed UI

  Features:
  - Beautiful terminal UI with markdown rendering
  - Multiple assistant support
  - Local tool integration (filesystem, git, etc.)
  - Real-time streaming responses
  - Tool execution feedback
  - Stateless mode by default (no persistence)
  - Optional stateful mode for conversation history
  - Interactive model chooser

  Examples:
  # Start chat with model chooser
  ir-ts2 chat

  # Create stateless chat with specific model and filesystem tools
  ir-ts2 chat --model gpt-4 --fs

  # Continue existing chat (stateful mode)
  ir-ts2 chat --model gpt-4 --chat <chat-id>

  # Force stateful mode without existing chat
  ir-ts2 chat --model gpt-4 --no-stateless --fs

  # With assistants and tools
  ir-ts2 chat --model claude-3 --assistant code-helper --fs --git

  # With custom tool file
  ir-ts2 chat --model gpt-4 --tool ./my-tools.js

  # One-shot mode
  ir-ts2 chat --model gpt-4 --message "Explain this code" --input src/app.ts

EXAMPLES
  $ ir-ts2 chat

  $ ir-ts2 chat --model gpt-4 --fs

  $ ir-ts2 chat --model gpt-4 --chat <chat-id>

  $ ir-ts2 chat --model claude-3 --assistant code-helper --fs --git

  $ ir-ts2 chat --model gpt-4 --tool ./my-tools.js

  $ ir-ts2 chat --model gpt-4 --message "Explain this code" --input src/app.ts

  $ ir-ts2 chat --model gpt-4 --no-stateless --fs  # Force stateful mode

`ir dataset clear [DATASETS]`

Clear dataset data within Elasticsearch

USAGE
  $ ir dataset clear [DATASETS...] [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H
    <value>...] [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth
    <value>] [--as <value>] [-i] [-a]

ARGUMENTS
  DATASETS...  zero or more datasets to clear

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -a, --all                           clear all datasets
  -c, --config=<value>                the path to a json config file for command flags
  -i, --interactive                   require confirmation before clearing
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Clear dataset data within Elasticsearch

EXAMPLES
  $ ir dataset clear

  $ ir dataset clear admin:northwind-orders

  $ ir dataset clear admin:northwind-orders admin:accidents

  $ ir dataset clear --all -i

`ir dataset data DATASET`

Export dataset data to various formats

USAGE
  $ ir dataset data DATASET [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-o csv|json|xlsx|xml] [--option KEY=VALUE...] [--omit <value>...] [--include <value>...] [-s
    <value>...] [-q <value>] [-f <value>...] [-z <value>] [--format] [-l <value>]

ARGUMENTS
  DATASET  the dataset to export data from

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --filter=<value>...             JSON Elasticsearch filter expressions
  -k, --token=<value>                 authenticate with an Informer API token
  -l, --limit=<value>                 maximum number of records to return
  -o, --output=<option>               [default: csv] the output type
                                      <options: csv|json|xlsx|xml>
  -q, --query=<value>                 Elasticsearch query string
  -s, --sort=<value>...               fields to sort by (prefix with - for descending)
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
  -z, --timezone=<value>              timezone for formatting timestamps (e.g., America/New_York)
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --[no-]format                   apply string formatting rules to the output
      --include=<value>...            fields to include in output (omits all others)
      --omit=<value>...               fields to omit from output
      --option=KEY=VALUE...           output specific options (key=value or key:=jsonValue)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Export dataset data to various formats

  Streams the dataset's data to standard output according to formatting and filtering options.
  Supports multiple output formats including CSV, JSON, XLSX, and XML.

EXAMPLES
  $ ir dataset data admin:northwind-orders

  $ ir dataset data admin:northwind-orders --output json

  $ ir dataset data admin:northwind-orders --output json -o pretty:=true

  $ ir dataset data admin:northwind-orders --no-format

  $ ir dataset data admin:northwind-orders -f '{"term": {"ShipRegion": "NM"}}'

  $ ir dataset data admin:northwind-orders --include OrderID --include CustomerID

  $ ir dataset data admin:northwind-orders --sort OrderDate --limit 100

  $ ir dataset data admin:northwind-orders -q "ShipCountry:USA" --timezone America/New_York

`ir dataset indices`

List dataset index mappings across all tenants

USAGE
  $ ir dataset indices [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f <value>] [--csv] [--output csv|json|yaml] [--sort tenant|dataset|index|-tenant|-dataset|-index]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --filter=<value>                filter by tenant or dataset name (partial match)
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --csv                           output as CSV format
      --output=<option>               output in a more machine friendly format
                                      <options: csv|json|yaml>
      --sort=<option>                 property to sort by
                                      <options: tenant|dataset|index|-tenant|-dataset|-index>
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  List dataset index mappings across all tenants

  Shows which Elasticsearch index each dataset points to for each tenant.
  This is useful for understanding index routing and bulk index updates.

EXAMPLES
  $ ir dataset indices

  $ ir dataset indices --filter northwind

  $ ir dataset indices --output json

  $ ir dataset indices --sort tenant

`ir dataset list`

display a table of the datasets available to the current user

USAGE
  $ ir dataset list [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-l] [--filter <value>] [--csv] [--output csv|json|yaml] [--sort
    id|naturalId|records|size|dataUpdatedAt|-id|-naturalId|-records|-size|-dataUpdatedAt]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -k, --token=<value>                 authenticate with an Informer API token
  -l, --long                          long format - show detailed table
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --csv                           output is csv format
      --filter=<value>                filter datasets by partial string matching in naturalId
      --output=<option>               output in a more machine friendly format
                                      <options: csv|json|yaml>
      --sort=<option>                 property to sort by (prepend '-' for descending)
                                      <options: id|naturalId|records|size|dataUpdatedAt|-id|-naturalId|-records|-size|-d
                                      ataUpdatedAt>
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  display a table of the datasets available to the current user

EXAMPLES
  $ ir-ts2 dataset:list

  $ ir-ts2 dataset:list --long

  $ ir-ts2 dataset:list --output json

  $ ir-ts2 dataset:list --filter northwind

`ir dataset refresh DATASET`

Refresh a dataset

USAGE
  $ ir dataset refresh DATASET [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-q]

ARGUMENTS
  DATASET  the dataset to refresh

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -k, --token=<value>                 authenticate with an Informer API token
  -q, --quiet                         suppress all output except errors
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       show detailed progress output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Refresh a dataset

  Triggers a dataset refresh and reports progress in real-time.
  The refresh operation will re-index the dataset data from the source.

EXAMPLES
  $ ir dataset refresh admin:northwind-orders

  $ ir dataset refresh admin:northwind-orders --verbose

  $ ir dataset refresh admin:northwind-orders --quiet

`ir dataset search DATASET`

Execute an Elasticsearch query against a dataset

USAGE
  $ ir dataset search DATASET [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f <value>] [-q <value>] [-p] [--indent <value>] [-s <value>] [--from <value>] [--source <value>...]

ARGUMENTS
  DATASET  the dataset to search

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --file=<value>                  file containing the Elasticsearch query JSON
  -k, --token=<value>                 authenticate with an Informer API token
  -p, --pretty                        format JSON output with colors and indentation
  -q, --query=<value>                 inline Elasticsearch query JSON string
  -s, --size=<value>                  maximum number of results to return (overrides query size)
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --from=<value>                  starting offset for results (pagination)
      --indent=<value>                [default: 2] indentation spaces for pretty output
      --source=<value>...             specific fields to return in results
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Execute an Elasticsearch query against a dataset

  Passes an Elasticsearch query directly to the dataset and returns results.
  Query can be provided via file, inline JSON, or stdin.

EXAMPLES
  $ ir dataset search admin:northwind-orders -f query.json --pretty

  $ ir dataset search admin:northwind-orders -q '{"query": {"match_all": {}}}'

  $ ir dataset search admin:northwind-orders --pretty --size 10

  echo '{"query": {"match_all": {}}}' | ir dataset search admin:northwind-orders

  $ ir dataset search admin:northwind-orders -f query.json --source OrderID --source CustomerID

`ir dataset set-index [DATASETS]`

Set a dataset's Elasticsearch index pointer

USAGE
  $ ir dataset set-index [DATASETS...] -i <value> [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>]
    [-H <value>...] [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>]
    [--auth <value>] [--as <value>] [-a] [-I]

ARGUMENTS
  DATASETS...  datasets to update (leave empty with --all to update all)

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -I, --interactive                   require confirmation before updating each dataset
  -U, --session=<value>               the session to use when connecting
  -a, --all                           update all datasets in the current tenant
  -c, --config=<value>                the path to a json config file for command flags
  -i, --index=<value>                 (required) the Elasticsearch index name or template expression
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Set a dataset's Elasticsearch index pointer

  Updates the Elasticsearch index pointer for one or more datasets.
  Supports template expressions using lodash template syntax.

  Template variables available:
  - tenant: current tenant name
  - naturalId: full dataset identifier (tenant:slug)
  - slug: dataset slug (without tenant prefix)
  - id: dataset ID
  - name: dataset name (if available)

EXAMPLES
  $ ir dataset set-index admin:northwind-orders --index northwind-orders

  $ ir dataset set-index admin:northwind-orders --index "informer-<%= slug %>"

  $ ir dataset set-index --all --index "data-<%= tenant %>-<%= slug %>"

  $ ir dataset set-index dataset1 dataset2 --index "prod-<%= slug %>" --interactive

`ir dataset set-indices [DATASETS]`

Update dataset index mappings in bulk

USAGE
  $ ir dataset set-indices [DATASETS...] -i <value> [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>]
    [-H <value>...] [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>]
    [--auth <value>] [--as <value>] [-a | -t <value>...]

ARGUMENTS
  DATASETS...  datasets to update (leave empty to update all)

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -a, --all                           update indices for all tenants
  -c, --config=<value>                the path to a json config file for command flags
  -i, --index=<value>                 (required) the templated index expression to set
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --in=<value>...                 specific tenant(s) to update
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Update dataset index mappings in bulk

  Sets the Elasticsearch index pointer for datasets across tenants.
  Use templated expressions to dynamically route datasets to different indices.

EXAMPLES
  $ ir dataset set-indices --all --index "informer-data-v2"

  $ ir dataset set-indices --in tenant1 --in tenant2 --index "{{tenant}}-datasets"

  $ ir dataset set-indices my-dataset --all --index "{{tenant}}-{{dataset}}"

  $ ir dataset set-indices dataset1 dataset2 --in production --index "prod-{{dataset}}"

`ir datasource query DATASOURCE`

Execute a query against a datasource

USAGE
  $ ir datasource query DATASOURCE [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H
    <value>...] [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth
    <value>] [--as <value>] [-f <value>] [-q <value>] [-l sql|mongo|cypher|sparql] [-o table|json|csv|yaml] [--limit
    <value>] [--no-header]

ARGUMENTS
  DATASOURCE  the datasource to query

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --file=<value>                  file containing the query
  -k, --token=<value>                 authenticate with an Informer API token
  -l, --language=<option>             [default: sql] query language
                                      <options: sql|mongo|cypher|sparql>
  -o, --output=<option>               [default: table] output format
                                      <options: table|json|csv|yaml>
  -q, --query=<value>                 inline query string
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --limit=<value>                 maximum number of rows to display
      --no-header                     hide column headers in table/csv output
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Execute a query against a datasource

  Runs a query against a datasource and displays the results.
  Query can be provided via file, inline string, or stdin.
  Supports multiple query languages including SQL, MongoDB, Cypher, and SPARQL.

EXAMPLES
  $ ir datasource query my-datasource -f query.sql

  $ ir datasource query my-datasource -q "SELECT * FROM users LIMIT 10"

  $ ir datasource query my-datasource -f query.sql --output json

  $ ir datasource query my-datasource -f query.sql --output csv

  echo "SELECT * FROM users" | ir datasource query my-datasource

  $ ir datasource query mongo-source -f query.js --language mongo

`ir db backup`

Back up an Informer instance

USAGE
  $ ir db backup [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f <value>] [--dir <value>] [--json] [--tokens] [--exceptions]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --file=<value>                  output filename
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --dir=<value>                   export to a bundle directory
      --exceptions                    include dataset indexing exceptions in the backup
      --json                          export Informer metadata in json format
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --[no-]tokens                   include tokens in the backup
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Back up an Informer instance

  Create a backup bundle of an Informer tenant. The output of the bundle is written to standard out unless the file
  flag is provided. Use the verbose option to view backup progress.

EXAMPLES
  $ ir db backup -vf backup.tgz

  $ ir db backup > backup.tgz

  $ ir db backup -v -U blue | ir db:restore -v -U green

`ir db restore`

Restore an Informer tenant from a backup bundle

USAGE
  $ ir db restore [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f <value>] [--dir <value>] [--buffer-size <value>]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --file=<value>                  bundle filename
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --buffer-size=<value>           [default: 819200] upload chunk size (in bytes)
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --dir=<value>                   import from a bundle directory
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Restore an Informer tenant from a backup bundle

  Restores an Informer tenant from a backup bundle. The bundle is read from standard input unless the file flag
  is specified. Use the verbose option to view restore progress.

  Note: You must log in again after restoring a tenant.

EXAMPLES
  $ ir db restore < backup.tgz

  $ ir db restore -v -f backup.tgz

  $ ir db restore --dir backup-dir -v

  $ ir db:backup -v -U blue | ir db restore -v -U green

`ir defaults`

sets default parameters for new sessions

USAGE
  $ ir defaults [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  sets default parameters for new sessions

  This command saves the provided flags as defaults for future sessions.
  When creating new sessions, these defaults will be used unless overridden.

EXAMPLES
  $ ir defaults --url https://demo.informer.cloud --tenant-header x-tenant

  $ ir defaults --url https://my-server.com --tenant my-tenant

  $ ir defaults --verbose

`ir delete PATH`

Deletes a REST resource

USAGE
  $ ir delete PATH [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f] [-p] [--indent <value>] [--websocket]

ARGUMENTS
  PATH  the path to delete

FLAGS
  -H, --header=<value>...             additional header to send (format: "Header-Name: value")
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --force                         skip confirmation prompt
  -k, --token=<value>                 authenticate with an Informer API token
  -p, --pretty                        display formatted json results
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --indent=<value>                [default: 2] pretty format indentation
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging
      --websocket                     use a websocket

DESCRIPTION
  Deletes a REST resource

  Issues an HTTP DELETE to the current Informer session and displays the response.
  By default, prompts for confirmation before deleting (use --force to skip).

EXAMPLES
  Delete a resource (with confirmation)

    $ ir delete /api/datasets/123

  Delete without confirmation

    $ ir delete /api/datasets/123 --force

  Delete with pretty output

    $ ir delete /api/datasets/123 -f --pretty

  Delete with custom headers

    $ ir delete /api/custom/456 -f -H "X-Custom-Header: value"

`ir deploy`

deploys content from the manager tenant to a child tenant

USAGE
  $ ir deploy [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [--to <value>... | --to-all] [--all] [--report <value>...] [--dataset <value>...] [--datasource
    <value>...] [--tag <value>...] [--overwrite] [--tokens] [--activity] [--replace-tags] [--replace-datasets]
    [--replace-reports] [--replace-queries] [--replace-folders] [--replace-content] [--json]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --activity                      copy activity
      --all                           deploys all content
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --dataset=<value>...            [default: ] deploys a dataset and its dependencies
      --datasource=<value>...         [default: ] deploys a datasource and its content
      --json                          deploys content using the JSON format
      --[no-]overwrite                overwrites a record if it exists
      --replace-content               replace all content (reports, datasets, queries, folders, tags)
      --replace-datasets              replace datasets
      --replace-folders               replace folders
      --replace-queries               replace queries
      --replace-reports               replace reports
      --replace-tags                  replace tags
      --report=<value>...             [default: ] deploys a report and its dependencies
      --tag=<value>...                [default: ] deploys all content for a tag
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --to=<value>...                 the destination tenant to deploy to
      --to-all                        deploy to all tenants
      --tokens                        copy tokens
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  deploys content from the manager tenant to a child tenant

EXAMPLES
  $ ir-ts2 deploy --to tenant1 tenant2

  $ ir-ts2 deploy --report test_report --to tenant1

  $ ir-ts2 deploy --tag production --to-all

`ir export`

back up an Informer instance.

USAGE
  $ ir export [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f <value>] [--dir <value>] [--report <value>...] [--dataset <value>...] [--query <value>...]
    [--datasource <value>...] [--tag <value>...] [--user <value>...] [--team <value>...] [--include-reports]
    [--include-queries] [--include-datasets] [--include-users] [--include-all] [--json]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --file=<value>                  output filename
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       show progress messages
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --dataset=<value>...            [default: ] exports a dataset and its dependencies
      --datasource=<value>...         [default: ] exports a datasource, its metadata, and (optionally) its associated
                                      content
      --dir=<value>                   export to a bundle directory
      --include-all                   includes all users and content associated with an exported datasource, user or
                                      team
      --include-datasets              includes datasets associated with an exported datasource, user or team
      --include-queries               includes queries associated with an exported datasource, user or team
      --include-reports               includes reports associated with an exported datasource, user or team
      --include-users                 includes all users associated with an exported team
      --json                          export Informer metadata in json format
      --query=<value>...              [default: ] exports a query and its dependencies
      --report=<value>...             [default: ] exports a report and its dependencies
      --tag=<value>...                [default: ] exports all content for a tag
      --team=<value>...               [default: ] exports a team and (optionally) its users and content
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging
      --user=<value>...               [default: ] exports a user and (optionally) their content

DESCRIPTION
  back up an Informer instance.

  Create a backup bundle of an Informer tenant. The output of the bundle is written to standard out unless the file
  flag is provided. Use the verbose option to view backup progress.

EXAMPLES
  $ ir-ts2 export -vf backup.tgz

  $ ir-ts2 export > backup.tgz

  $ ir-ts2 export -v --datasource myds --include-all -f backup.tgz

  $ ir-ts2 export --tag production --json -f backup.json.tgz

`ir get PATH [ARGS...]`

Gets a REST resource

USAGE
  $ ir get PATH... [ARGS......] [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H
    <value>...] [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth
    <value>] [--as <value>] [--pretty] [--indent <value>] [--websocket]

ARGUMENTS
  PATH...     the path to get
  ARGS......  additional query string args [arg name]==[arg value]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --indent=<value>                [default: 2] pretty format indentation
      --pretty                        display formatted json results
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging
      --websocket                     use a websocket

DESCRIPTION
  Gets a REST resource

  Issues an HTTP get to the current Informer session and displays a formatted
  JSON response

EXAMPLES
  $ ir get /api/me --pretty

  $ ir get /api/datasources sort==name

`ir help [COMMAND]`

Display help for ir.

USAGE
  $ ir help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for ir.

See code: @oclif/plugin-help

`ir impersonate USERNAME`

Impersonate another user

USAGE
  $ ir impersonate USERNAME [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-n <value>]

ARGUMENTS
  USERNAME  the user to impersonate

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -k, --token=<value>                 authenticate with an Informer API token
  -n, --name=<value>                  custom name for the new impersonated session
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Impersonate another user

  Creates a new session as another user within the same or different tenant.
  This is useful for testing user-specific functionality or troubleshooting issues.

EXAMPLES
  Impersonate user "joe" in current tenant

    $ ir impersonate joe

  Impersonate user "batman" in a different tenant

    $ ir impersonate batman -t wayne-enterprises

  Impersonate with a custom session name

    $ ir impersonate testuser --name test-session

`ir import`

import content from a bundle file

USAGE
  $ ir import [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f <value>] [--dir <value>] [--overwrite] [--replace-tags] [--replace-datasets] [--replace-reports]
    [--replace-queries] [--replace-folders] [--replace-content] [--buffer-size <value>]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --file=<value>                  bundle filename
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --buffer-size=<value>           [default: 819200] upload chunk size
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --dir=<value>                   import from a bundle directory
      --[no-]overwrite                overwrites a record if it exists
      --replace-content               replace all content (reports, datasets, queries, folders, tags)
      --replace-datasets              replace datasets
      --replace-folders               replace folders
      --replace-queries               replace queries
      --replace-reports               replace reports
      --replace-tags                  replace tags
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  import content from a bundle file

  Imports Informer content from a bundle file. The bundle is read from standard input unless the file flag
  is specified. Use the verbose option to view restore progress.

EXAMPLES
  $ ir-ts2 import < backup.tgz

  $ ir-ts2 import -v -f backup.tgz

  $ ir-ts2 import --dir ./backup-dir -v

`ir info`

Displays system version and build information

USAGE
  $ ir info [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [--json]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --json                          output raw JSON response
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  Displays system version and build information

  Shows the current Informer server version, build number, build date, and environment.

EXAMPLES
  $ ir info

  $ ir info --json

`ir ingest add DATASET`

adds a new ingest task to the queue

USAGE
  $ ir ingest add DATASET [--db <value>] [--reset] [-v] [-t <value>] [-i <value>...] [--start <value> --end
    <value> --interval <value>] [--pending] [--stage]

ARGUMENTS
  DATASET  the dataset to ingest

FLAGS
  -i, --input=<value>...  a runtime parameter (key=value or key:=jsonValue)
  -t, --tenant=<value>    [default: manager] the tenant containing the dataset to refresh
  -v, --verbose           enable verbose logging
      --db=<value>        [default: ingest] the name of the ingest database
      --end=<value>       the interval end date
      --interval=<value>  an ISO8601 duration for time interval slicing
      --pending           create tasks as PENDING instead of READY
      --reset             reset the database (clear all data)
      --[no-]stage        stage the ingest tasks for review before running
      --start=<value>     the interval start date

DESCRIPTION
  adds a new ingest task to the queue

EXAMPLES
  $ ir ingest:add admin:northwind-orders

  $ ir ingest:add -t wayne-enterprises admin:crimes -i status=ACTIVE

  $ ir ingest:add admin:sales --start 2024-01-01 --end 2024-02-01 --interval P1D

  $ ir ingest:add admin:events -i config:="{\"limit\": 1000}" --no-stage

`ir ingest clear`

clears finished tasks from the ingest database

USAGE
  $ ir ingest clear [--db <value>] [--reset] [-v] [-h] [-t <value>] [-d <value>]

FLAGS
  -d, --dataset=<value>  clear finished tasks for this dataset
  -h, --help             Show CLI help.
  -t, --tenant=<value>   clear finished tasks for this tenant
  -v, --verbose          enable verbose logging
      --db=<value>       [default: ingest] the name of the ingest database
      --reset            reset the database (clear all data)

DESCRIPTION
  clears finished tasks from the ingest database

  Discards completed tasks from the ingest database. Shorthand for "ir-ts2 ingest:delete --complete"

EXAMPLES
  $ ir-ts2 ingest:clear

  $ ir-ts2 ingest:clear --tenant wayne-enterprises

  $ ir-ts2 ingest:clear --dataset admin:northwind-orders

`ir ingest delete [IDS]`

deletes one or more tasks from the ingest database

USAGE
  $ ir ingest delete [IDS...] [--db <value>] [--reset] [-v] [--all] [-t <value>...] [-d <value>...] [--complete]
    [--errors] [--staged] [--started]

ARGUMENTS
  IDS...  the ids of tasks to delete

FLAGS
  -d, --dataset=<value>...  delete tasks for a dataset
  -t, --tenant=<value>...   delete tasks for a tenant
  -v, --verbose             enable verbose logging
      --all                 delete all tasks
      --[no-]complete       delete completed tasks
      --db=<value>          [default: ingest] the name of the ingest database
      --[no-]errors         delete tasks with errors
      --reset               reset the database (clear all data)
      --[no-]staged         delete staged tasks
      --[no-]started        delete running tasks

DESCRIPTION
  deletes one or more tasks from the ingest database

EXAMPLES
  $ ir-ts2 ingest:delete

  $ ir-ts2 ingest:delete --complete

  $ ir-ts2 ingest:delete --errors

  $ ir-ts2 ingest:delete --tenant manager

  $ ir-ts2 ingest:delete 1 2 3

  $ ir-ts2 ingest:delete --all

`ir ingest list [IDS]`

lists ingest tasks from the database

USAGE
  $ ir ingest list [IDS...] [--db <value>] [--reset] [-v] [-h] [--all] [-t <value>...] [-d <value>...]
    [--complete] [--errors] [--staged] [--started] [--filter <value>] [--csv] [--output csv|json|yaml] [--limit <value>]

ARGUMENTS
  IDS...  the ids of tasks to list

FLAGS
  -d, --dataset=<value>...  filter by dataset
  -h, --help                Show CLI help.
  -t, --tenant=<value>...   filter by tenant
  -v, --verbose             enable verbose logging
      --all                 show all tasks
      --[no-]complete       filter completed tasks
      --csv                 output in csv format
      --db=<value>          [default: ingest] the name of the ingest database
      --[no-]errors         filter tasks with errors
      --filter=<value>      filter property by partial string matching
      --limit=<value>       [default: -1] limit number of results
      --output=<option>     output in a more machine readable format
                            <options: csv|json|yaml>
      --reset               reset the database (clear all data)
      --[no-]staged         filter staged tasks
      --[no-]started        filter started tasks

DESCRIPTION
  lists ingest tasks from the database

EXAMPLES
  $ ir-ts2 ingest:list

  $ ir-ts2 ingest:list --tenant manager

  $ ir-ts2 ingest:list --errors --no-staged

  $ ir-ts2 ingest:list --output json

  $ ir-ts2 ingest:list --limit 10

`ir ingest load`

loads an ingest plan from a configuration json or js file

USAGE
  $ ir ingest load -f <value> [--db <value>] [--reset] [-v] [--stage]

FLAGS
  -f, --file=<value>  (required) path to configuration JSON or JS file
  -v, --verbose       enable verbose logging
      --db=<value>    [default: ingest] the name of the ingest database
      --reset         reset the database (clear all data)
      --[no-]stage    stage the tasks (default: true)

DESCRIPTION
  loads an ingest plan from a configuration json or js file

EXAMPLES
  $ ir-ts2 ingest:load -f ingest-plan.json

  $ ir-ts2 ingest:load --file config/ingest.js --no-stage

  $ ir-ts2 ingest:load -f plan.json --stage

`ir ingest monitor`

monitors active ingest tasks with real-time updates

USAGE
  $ ir ingest monitor [--db <value>] [--reset] [-v] [-n <value>] [--detail] [--summary] [--total] [-i <value>]

FLAGS
  -i, --interval=<value>  [default: 100] refresh interval in milliseconds
  -n, --size=<value>      [default: 30] maximum number of active tasks to display
  -v, --verbose           enable verbose logging
      --db=<value>        [default: ingest] the name of the ingest database
      --[no-]detail       show or hide detail level information for running tasks
      --reset             reset the database (clear all data)
      --[no-]summary      show or hide tenant/dataset summary information for running tasks
      --[no-]total        show or hide total line information for running tasks

DESCRIPTION
  monitors active ingest tasks with real-time updates

EXAMPLES
  $ ir ingest:monitor

  $ ir ingest:monitor --no-detail

  $ ir ingest:monitor --no-summary

  $ ir ingest:monitor --size 50

  $ ir ingest:monitor --interval 500

`ir ingest plan`

creates an ingest plan file from the datasets in the account

USAGE
  $ ir ingest plan [-u <value>] [-t <value>] [-U <value>] [-k <value>] [-v] [-c <value>] [-H <value>...]
    [--cookie <value>...] [--tenant-header <value>] [--tls-reject-unauthorized] [--trace-id <value>] [--auth <value>]
    [--as <value>] [-f <value>]

FLAGS
  -H, --header=<value>...             one or more header name/values (e.g. sid=SESSION_ID)
  -U, --session=<value>               the session to use when connecting
  -c, --config=<value>                the path to a json config file for command flags
  -f, --file=<value>                  the file to write to
  -k, --token=<value>                 authenticate with an Informer API token
  -t, --tenant=<value>                the Informer tenant to connect as
  -u, --url=<value>                   the Informer URL to connect to
  -v, --verbose                       enable verbose output
      --as=<value>                    tenant to impersonate while running the command
      --auth=<value>                  Authentication credentials (USER[:PASS])
      --cookie=<value>...             one or more cookie values to add to the header (e.g. sid=SESSION_ID)
      --tenant-header=<value>         the request header to use for transmitting the tenant
      --[no-]tls-reject-unauthorized  rejects https requests to servers whose certs cannot be verified
      --trace-id=<value>              Adds a trace id to all XHR and websocket requests for server-side logging

DESCRIPTION
  creates an ingest plan file from the datasets in the account

EXAMPLES
  $ ir-ts2 ingest:plan -f ingest-plan.json

  $ ir-ts2 ingest:plan --url https://my-informer.com --tenant admin

`ir ingest:restart`

restarts one or more ingest tasks. By default, only tasks that failed to complete will be restarted.

USAGE
  $ ir ingest restart
  $ ir ingest restart --all
  $ ir ingest restart --complete --tenant manager
  $ ir ingest restart --dataset admin:northwind-orders

ARGUMENTS
  IDS...  the ids of tasks to restart

FLAGS
  -d, --dataset=<value>...  filter by dataset
  -t, --tenant=<value>...   filter by tenant
  -v, --verbose             enable verbose logging
      --all                 restart all tasks
      --[no-]complete       include completed tasks
      --db=<value>          [default: ingest] the name of the ingest database
      --[no-]errors         include errored tasks (default: true)
      --reset               reset the database (clear all data)
      --[no-]started        include started tasks

DESCRIPTION
  restarts one or more ingest tasks. By default, only tasks that failed to complete will be restarted.

`ir ingest server`

starts the ingest server

USAGE
  $ ir ingest server [--db <value>] [--reset] [-v] [-h] [-n <value>] [--interval <value>] [--retries <value>]
    [--idle-timeout <value>] [--reverse-chronological] [--stateless-refresh] [--pause-interval <value>]
    [--update-type-mapping] [--sync-fields] [--disable-refresh-interval]

FLAGS
  -h, --help                      Show CLI help.
  -n, --workers=<value>           [default: 10] the maximum number of in-flight requests
  -v, --verbose                   enable verbose logging
      --db=<value>                [default: ingest] the name of the ingest database
      --disable-refresh-interval  specifies whether Informer should disable the Elasticsearch refresh interval setting
                                  while indexing. Enable for fewer refreshes with lots of records each
      --idle-timeout=<value>      [default: 1800000] a timeout value for cancelling refresh requests that have been idle
                                  for a period of time
      --interval=<value>          [default: 1000] the polling interval for new tasks to run
      --pause-interval=<value>    the time to pause between refresh requests
      --reset                     resets the database to a pristine state
      --retries=<value>           [default: 3] maximum number of retry attempts for a command before giving up
      --reverse-chronological     loads tasks in reverse chronological order based on interval date range
      --[no-]stateless-refresh    uses the new stateless refresh option in 5.3 and higher
      --[no-]sync-fields          specifies whether Informer should update dataset field definitions on each refresh.
                                  Disable for faster refreshes when the dataset field definitions already exist
      --[no-]update-type-mapping  specifies whether Informer should update Elasticsearch type mappings on each refresh.
                                  Disable for faster refreshes when the type mapping is already established.

DESCRIPTION
  starts the ingest server

  The ingest server waits for ready commands to be added to its database, runs them, and saves progress information
  back to the database. Commands are considered ready if they are not staged, not complete, not running, and have
  been retried fewer than the max number of retries.

  When the ingest server starts up it will make sure its database has been created and will reset any commands marked
  running back to a not-started state.

EXAMPLES
  $ ir ingest:server

  $ ir ingest:server -v --retries 1

`ir ingest start [IDS]`

starts one or more staged ingest tasks. By default all staged tasks will be started

USAGE
  $ ir ingest start [IDS...] [

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@entrinsik/ir-cli

Usage

Commands

ir chat

ir dataset clear [DATASETS]

ir dataset data DATASET

ir dataset indices

ir dataset list

ir dataset refresh DATASET

ir dataset search DATASET

ir dataset set-index [DATASETS]

ir dataset set-indices [DATASETS]

ir datasource query DATASOURCE

ir db backup

ir db restore

ir defaults

ir delete PATH

ir deploy

ir export

ir get PATH [ARGS...]

ir help [COMMAND]

ir impersonate USERNAME

ir import

ir info

ir ingest add DATASET

ir ingest clear

ir ingest delete [IDS]

ir ingest list [IDS]

ir ingest load

ir ingest monitor

ir ingest plan

ir ingest:restart

ir ingest server

ir ingest start [IDS]