# @activeai/triniti-cli

> Triniti cli ===========

Latest version **0.1.5** (published 2019-06-20) · Active AI License license · 0 weekly downloads

## Install

```sh
npm install @activeai/triniti-cli
pnpm add @activeai/triniti-cli
yarn add @activeai/triniti-cli
bun add @activeai/triniti-cli
```

Provides the command `triniti-cli`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2019-06-20 |
| First published | 2019-04-02 |
| Weekly downloads | 0 |
| License | Active AI License |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 17 |
| Unpacked size | 174.2 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | activeai |
| Maintainers | activeaiadmin, avinashjayakumar |
| Keywords | triniti-cli, oclif |

## Links

- npm: https://www.npmjs.com/package/@activeai/triniti-cli
- Repository: https://bitbucket.org/morfeus-product/triniti-cli
- Homepage: https://docs.triniti.ai/reference.html#triniti-cli
- npm.io page: https://npm.io/package/@activeai/triniti-cli

## Dependencies (17)

- [axios](https://npm.io/package/axios.md) ^0.19.0
- [tslib](https://npm.io/package/tslib.md) ^1
- [cli-ux](https://npm.io/package/cli-ux.md) ^5.2.0
- [moment](https://npm.io/package/moment.md) ^2.24.0
- [conf-cli](https://npm.io/package/conf-cli.md) ^0.1.8
- [jsonfile](https://npm.io/package/jsonfile.md) ^5.0.0
- [csvtojson](https://npm.io/package/csvtojson.md) ^2.0.8
- [ascii-table](https://npm.io/package/ascii-table.md) 0.0.9
- [query-string](https://npm.io/package/query-string.md) ^6.5.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1
- [set-cookie-parser](https://npm.io/package/set-cookie-parser.md) ^2.3.5
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^2
- [@oclif/plugin-commands](https://npm.io/package/@oclif/plugin-commands.md) ^1.2.2
- [@oclif/plugin-not-found](https://npm.io/package/@oclif/plugin-not-found.md) ^1.2.2
- [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^0.1.0
- [@oclif/plugin-warn-if-update-available](https://npm.io/package/@oclif/plugin-warn-if-update-available.md) ^1.7.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.5 (latest) — 2019-06-20
- 0.1.4 — 2019-06-20
- 0.1.3 — 2019-06-19
- 0.1.2 — 2019-06-19
- 0.1.1 — 2019-06-10
- 0.0.14 — 2019-04-13
- 0.0.13 — 2019-04-08
- 0.0.12 — 2019-04-04
- 0.0.11 — 2019-04-03
- 0.0.10 — 2019-04-03
- 0.0.9 — 2019-04-03
- 0.0.8 — 2019-04-03
- 0.0.7 — 2019-04-03
- 0.0.6 — 2019-04-03
- 0.0.5 — 2019-04-03
- … 3 more at https://npm.io/package/@activeai/triniti-cli/versions

## README

Triniti cli
===========

A Command line utility for Triniti AI

---


[![activeai](https://img.shields.io/badge/cli-activeai-blue.svg)](https://active.ai)

<!-- toc -->
* [Prerequisites](#Prerequisites)
* [Installing](#Installing)
* [Commands](#commands)
* [Usage](#usage)
* [Version check](#versioncheck)
* [Configure](#configure)
* [FAQ](#faq)
* [Train](#train)
* [Analytics](#analytics)
* [Help](#help)

<!-- tocstop -->


# Prerequisites
<!-- prerequisites -->
Ensure you have the following prerequisites:

* You need an [Triniti Cloud][triniti-cloud-onboarding] account.
* Install [Node.js][nodejs] v10.x.x or above.

<!-- prerequisitesstop -->

# Installing
<!-- Installing -->
```
$ npm i -g @activeai/triniti-cli
```
<!-- Installingstop -->

# Commands
<!-- commands -->
* [`triniti-cli conf`](#triniti-cli-conf)
* [`triniti-cli faq`](#triniti-cli-faq)
* [`triniti-cli train`](#triniti-cli-train)
* [`triniti-cli analytics`](#triniti-cli-analytics)
* [`triniti-cli help`](#triniti-cli-help-command)

<!-- commandsstop -->


# Usage
<!-- usage -->
```
$ triniti-cli [COMMAND] [ ...args ]
```
<!-- usagestop -->


# Version check
<!-- versioncheck -->
```
USAGE
  $ triniti-cli (-v|--version|version)
```
<!-- versioncheckstop -->



# Configure
<!-- configure -->
Manage Triniti Cli configuration

Triniti Cli expects the following keys to be set.

1. **api-key**
2. **api-secret**
3. **email-id**
4. **password**
5. **workspace-id**

```
USAGE
  $ triniti-cli conf [KEY] [VALUE]

ARGUMENTS
  KEY       key of the config
  VALUE     value of the config

OPTIONS
  -d, --delete            delete the key
  -k, --key=key           key of the config
  -v, --value=value       value of the config


EXAMPLE

    list configurations
    $ triniti-cli conf

    Set a configuration
    $ triniti-cli conf [KEY] [VALUE]
    $ triniti-cli conf email-id test1

    Get a value configured
    $ triniti-cli conf [KEY]
    $ triniti-cli conf email-id

    Remove a configuration
    $ triniti-cli conf [KEY] -d
    $ triniti-cli conf email-id -d

```
<!-- configurestop -->

# FAQ
<!-- faq -->
Add/Remove FAQs in the workspace

```
USAGE
  $ triniti-cli faq

OPTIONS
  -h, --help           show help for faq command
  -a, --add=add        add faq(s)
  -r, --remove=remove  remove faq
  -R, --removeAll      remove all FAQs

EXAMPLE

    Add faqs
    $ triniti-cli faq -a filename.csv

    Remove a faq
    $ triniti-cli faq -r faqId

    Remove all FAQs
    $ triniti-cli faq -R
```
<!-- faqstop -->

# Train
<!-- train -->
Train the AI models

```
USAGE
  $ triniti-cli train

OPTIONS
  -h, --help       show help for train command
  -s, --status     display current status of training
  -d, --days       display status of training for days configured
  -t, --type       shallow | full (default)

EXAMPLE

    Train AI models in the workspace
    $ triniti-cli train --type [full | shallow]

    Get the status of training
    $ triniti-cli train --status

    Get the status of training for specific number of days
    $ triniti-cli train --status --days=30
```
<!-- trainstop -->


# Analytics
<!-- analytics -->
Get Analytics

```
USAGE
  $ triniti-cli analytics 

OPTIONS
  -f, --filename   filename to save transcripts
  -i, --customerId Analytics for the specified customerId
  -t, --transcript Get the chat transcripts
  -u, --type of user
  

EXAMPLE

    get chat transcripts of a customer with customerId
    $ triniti-cli analytics -ti customerId 

    get chat transcripts of a customer with customerId saved to a file, given a filename
    $ triniti-cli analytics -ti customerId -f chat_transcripts.json

    get chat transcripts of a registered customer
    $ triniti-cli analytics analytics -ti registered_user_customerId -u registered

```
<!-- analyticsstop -->

# Help
<!-- help -->
Displays CLI help menu

```
USAGE
  $ triniti-cli help  
```
<!-- helpstop -->

[triniti-cloud-onboarding]: https://developer.triniti.ai/login
[nodejs]: https://nodejs.org/en/

---
_Source: https://npm.io/package/@activeai/triniti-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
