# tcag-client

> Command line tool for transfer portal.

Latest version **1.4.2** (published 2018-10-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install tcag-client
pnpm add tcag-client
yarn add tcag-client
bun add tcag-client
```

Provides the command `tcag-client`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.2 |
| Published | 2018-10-18 |
| First published | 2018-04-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=v10.1.0 |
| Dependencies | 16 |
| Unpacked size | 57.6 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| Author | milan@dnastack.com |
| Maintainers | mpanik |

## Links

- npm: https://www.npmjs.com/package/tcag-client
- Repository: https://github.com/DNAstack/transfer-portal-cli
- Homepage: https://github.com/DNAstack/transfer-portal-cli#readme
- Issues: https://github.com/DNAstack/transfer-portal-cli/issues
- npm.io page: https://npm.io/package/tcag-client

## Dependencies (16)

- [async](https://npm.io/package/async.md) ^2.6.1
- [axios](https://npm.io/package/axios.md) ^0.18.0
- [bytes](https://npm.io/package/bytes.md) ^3.0.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [debug](https://npm.io/package/debug.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^12.0.1
- [dotenv](https://npm.io/package/dotenv.md) ^6.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [moment](https://npm.io/package/moment.md) ^2.22.2
- [winston](https://npm.io/package/winston.md) ^3.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^6.0.0
- [terminal-kit](https://npm.io/package/terminal-kit.md) ^1.22.1
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0
- [promise-retry](https://npm.io/package/promise-retry.md) ^1.1.1
- [text-ellipsis](https://npm.io/package/text-ellipsis.md) ^1.0.3

## Recent versions

- 1.4.2 (latest) — 2018-10-18
- 1.2.0-exp.3 (experimental) — 2018-06-18
- 1.4.0 — 2018-08-07
- 1.3.0 — 2018-07-24
- 1.2.2 — 2018-07-12
- 1.2.1 — 2018-06-27
- 1.2.0 — 2018-06-20
- 1.2.0-exp.2 — 2018-06-18
- 1.2.0-exp.1 — 2018-06-18
- 1.2.0-exp.0 — 2018-06-15
- 1.1.0 — 2018-06-07
- 1.0.0 — 2018-04-25

## README

# TCAG CLI

## Prerequisites

- node `^10.1.0`
- npm `^6.0.1`
- (optional) [pkg](https://github.com/zeit/pkg) `4.3.4`

## Usage

### Using tty stdout

This is recommended way using the CLI tool. Progress bar is visible during entire download process.

```bash
tcag-client download -p 'ABCD123:/'
```

## Development

While developing, you will probably rely mostly on `npm start`. There are additional scripts at your disposal:

|`npm run <script>`|Description|
|------------------|-----------|
|`clean`|Deletes dist folder.|
|`build`|Compiles the application to `/dist` folder.|
|`link`|Compiles the application and creates symlink [See linking command](#linking-command).|
|`lint`|Lint all `.js` files.|
|`lint:fix`|Lint and fix all `.js` files. [Read more on this](http://eslint.org/docs/user-guide/command-line-interface.html#fix).|
|`pack`|Build and create self-contained executables.|

Note that some aliases may not work, it is known limitation. In case of command linking all aliases should work.

### Environment variables

You can modify behaviour by using environment variables below:

```bash
REST_API_HOST_URL=
API_VERSION=v1
OAUTH_HOST_URL=
OAUTH_CLIENT_ID=
TRANSFER_CLI_USERNAME=
TRANSFER_CLI_PASSWORD=
```

Variables can be put in `.env` file.

### Linking command

You can easily create symlink with:

```bash
npm run link
```

Now you can use command as:

```bash
tcag-client <command> [options]
```

Optionally you may want to remove symlink:

```bash
npm unlink
```

You may run into naming issue if you have `tcag-client` already globally installed, in that case just rename symlink in `bin` section of `package.json`.

## Generating self-contained executables

```bash
pkg -t node10-linux-x64,node10-macos-x64,node8-win-x64 .
```

Takes `package.json` from cwd and follows `bin` and `pkg` entry. For more info see [pkg github](https://github.com/zeit/pkg).

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