# ledger-tool

> Simple Node.js CLI tool to handle a bank ledger workflow

Latest version **1.0.1** (published 2018-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install ledger-tool
pnpm add ledger-tool
yarn add ledger-tool
bun add ledger-tool
```

Provides the command `ledger`.

## 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.0.1 |
| Published | 2018-12-06 |
| First published | 2018-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lindsay Groves |
| Maintainers | linzgroves |

## Links

- npm: https://www.npmjs.com/package/ledger-tool
- Repository: https://github.com/linzgroves/ledger-tool
- Homepage: https://github.com/linzgroves/ledger-tool#readme
- Issues: https://github.com/linzgroves/ledger-tool/issues
- npm.io page: https://npm.io/package/ledger-tool

## Dependencies (2)

- [inquirer](https://npm.io/package/inquirer.md) ^6.2.1
- [commander](https://npm.io/package/commander.md) ^2.19.0

## Recent versions

- 1.0.1 (latest) — 2018-12-06
- 1.0.0 — 2018-12-06

## README

# Ledger CLI Tool

Simple tool to run basic workflows for a bank ledger.

## Description

A Node.js tool that can be run via the command line that allows the following workflows to take place:
* Create an account
* Login to the account
* Record a deposit
* Check balance
* See transaction history
* Log out

The tool uses temporary data so an account created cannot be logged back into with the current version of this tool.

### Installing

```
npm install ledger-tool
```

### Executing program

To begin, run:
```
ledger startSession
```
The tool will guide you through the workflows, starting with creating and account and then logging in with those credentials.
Once you're logged in, you'll be taken to a menu where you can move through the workflows and eventually log out when you're done.

## Help

Currently, since there's only one command to get the app going, no --help commands were provided. However, there are a few statements printed out that should guide the user.

## Authors

Lindsay Groves

## Version History

* 0.1
    * Initial Release

## License

This project is licensed under the MIT License - see the LICENSE.md file for details

## Acknowledgments

Inspiration, code snippets, etc.
* [A helpful start](https://timber.io/blog/creating-a-real-world-cli-app-with-node/)
* [Another great resource](https://medium.freecodecamp.org/writing-command-line-applications-in-nodejs-2cf8327eee2)

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