# @squirrel-forge/node-terminal

> A node commandline abstraction, simple cli structure and application wrapper with commands

Latest version **2.0.3** (published 2021-12-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @squirrel-forge/node-terminal
pnpm add @squirrel-forge/node-terminal
yarn add @squirrel-forge/node-terminal
bun add @squirrel-forge/node-terminal
```

Provides the commands `nt-app`, `nt-demo`.

## 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 | 2.0.3 |
| Published | 2021-12-05 |
| First published | 2021-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 30 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Daniel Hartwell |
| Maintainers | dasiux |
| Keywords | terminal, abstract, commands, helpers |

## Links

- npm: https://www.npmjs.com/package/@squirrel-forge/node-terminal
- Repository: https://github.com/squirrel-forge/node-terminal
- Homepage: https://github.com/squirrel-forge/node-terminal#readme
- Issues: https://github.com/squirrel-forge/node-terminal/issues
- npm.io page: https://npm.io/package/@squirrel-forge/node-terminal

## Dependencies (4)

- [ucfirst](https://npm.io/package/ucfirst.md) ^1.0.0
- [@squirrel-forge/node-cfx](https://npm.io/package/@squirrel-forge/node-cfx.md) ^1.0.2
- [@squirrel-forge/node-util](https://npm.io/package/@squirrel-forge/node-util.md) ^1.0.0
- [@squirrel-forge/node-objection](https://npm.io/package/@squirrel-forge/node-objection.md) ^1.0.1

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 2.0.3 (latest) — 2021-12-05
- 2.0.2 — 2021-11-24
- 2.0.0 — 2021-11-21
- 1.1.0 — 2021-06-19
- 1.0.0 — 2021-06-17

## README

# node-terminal

A node commandline abstraction, application wrapper and commands.

## Installation

```
npm i @squirrel-forge/node-terminal

```

## Usage

```
const { Class } = require( '@squirrel-forge/node-terminal' );
```

### Classes

 - Application( options, init )
   - timer : Timer
   - options : Object
   - input : CliInput
   - progress : Progress
   - setInputProps( target, flags )
   - register ( constructor )
   - getCommandName( name )
   - getCommandInstance( constructor, options )
   - run( options, exit )
   - exit( code, time )
 - Command( app, options )
   - app : Application
   - options : Object
   - argData( index )
   - flagData( flag )
   - getDefaultString( def )
   - describe()
   - before()
   - fire()
 - HelpCommand( app ) extends Command
   - fire()

## Docs

Check the sourcecode on [github](https://github.com/squirrel-forge/node-terminal) for extensive comments.

---
_Source: https://npm.io/package/@squirrel-forge/node-terminal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
