# investment-divider

> A CLI to determine how many shares of each asset to purchase when given a limited amount of capital.

Latest version **0.1.5** (published 2021-01-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install investment-divider
pnpm add investment-divider
yarn add investment-divider
bun add investment-divider
```

Provides the command `divide-investments`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2021-01-01 |
| First published | 2020-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jackson Yuan |
| Maintainers | jacksonyuanjx |
| Keywords | cli, investment |

## Links

- npm: https://www.npmjs.com/package/investment-divider
- Repository: https://github.com/jacksonyuanjx/InvestmentDivider
- Homepage: https://github.com/jacksonyuanjx/InvestmentDivider#readme
- Issues: https://github.com/jacksonyuanjx/InvestmentDivider/issues
- npm.io page: https://npm.io/package/investment-divider

## Dependencies (4)

- [kleur](https://npm.io/package/kleur.md) ^4.1.3
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [commander](https://npm.io/package/commander.md) ^6.2.1
- [cli-table3](https://npm.io/package/cli-table3.md) ^0.6.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) — 2021-01-01
- 0.1.4 — 2020-12-25
- 0.1.3 — 2020-12-25
- 0.1.2 — 2020-12-25

## README

# Investment Divider CLI
[![Master Branch Build](https://github.com/jacksonyuanjx/InvestmentDivider/workflows/Checks/badge.svg)](https://github.com/jacksonyuanjx/InvestmentDivider/actions)
![Deployment](https://github.com/jacksonyuanjx/InvestmentDivider/workflows/Deployment/badge.svg)
[![npm](https://img.shields.io/npm/v/investment-divider.svg)](https://www.npmjs.com/package/investment-divider)
[![Downloads](https://img.shields.io/npm/dt/investment-divider.svg)](https://www.npmjs.com/package/investment-divider)
[![codecov](https://codecov.io/gh/jacksonyuanjx/InvestmentDivider/branch/master/graph/badge.svg?token=BPTV0A9SCX)](https://codecov.io/gh/jacksonyuanjx/InvestmentDivider)
[![Known Vulnerabilities](https://snyk.io/test/github/jacksonyuanjx/InvestmentDivider/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jacksonyuanjx/InvestmentDivider?targetFile=package.json)

Investment Divider is a CLI tool built to help you evenly divide an input amount of capital into various investments while maximizing the number of investments made. By using this CLI, you can quickly decide how many shares of each investment to buy if you wish to evenly distribute your capital.


## Table of Contents

- [Features](#features)
- [Install](#install)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#license)

## Features
* accepts a given amount of capital as well as various tickers and their current prices

## Install
```bash
npm i investment-divider -g
```
or
```bash
yarn global add investment-divider
```

## Usage
1. Run `divide-investments divide` in your terminal.
2. Follow the prompt that appears and enter the total amount of capital that you'd like to divide.
3. For each investment you're considering:
    * enter the ticker of the investment
    * enter the current price of the investment
4. When all the tickers & prices of all investments are entered, type `q` and hit enter.
5. The output will show you how many shares of each investment to buy and how much of your total capital is allocated towards these investments.

## Maintainers
[@jacksonyuanjx](https://github.com/jacksonyuanjx)

## Contribute
If you'd like to report a bug or wish to request a feature, feel free to create a new issue or PR.

## License
MIT © Jackson Yuan

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