https://github.com/squirrel-forge/node-terminal
A node commandline abstraction, application wrapper and commands
https://github.com/squirrel-forge/node-terminal
Last synced: about 1 year ago
JSON representation
A node commandline abstraction, application wrapper and commands
- Host: GitHub
- URL: https://github.com/squirrel-forge/node-terminal
- Owner: squirrel-forge
- License: mit
- Created: 2021-06-16T16:27:50.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-12-05T15:07:23.000Z (over 4 years ago)
- Last Synced: 2025-02-05T04:05:42.284Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
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.