https://github.com/codesandtags/financial-markets-cli
A CLI tool to get stock or markets information from the terminal.
https://github.com/codesandtags/financial-markets-cli
Last synced: over 1 year ago
JSON representation
A CLI tool to get stock or markets information from the terminal.
- Host: GitHub
- URL: https://github.com/codesandtags/financial-markets-cli
- Owner: codesandtags
- Created: 2024-11-01T23:13:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-02T04:02:56.000Z (over 1 year ago)
- Last Synced: 2024-11-02T05:16:33.962Z (over 1 year ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Financial Markets CLI
Financial Markets CLI as `fm` on your terminal.
## Description
A CLI tool to get stock or markets information from the terminal.
This CLI tool is built using Node.js and the yahoo-finance2 package. It allows you to get information about a stock or market index by providing the ticker symbol.
### Features
- Get stock information by providing the ticker symbol.
- Store favorite stocks to get information about them quickly.
## Requirements
- Node.js
- npm
- Access to Internet
## Dependencies
- [yahoo-finance2](https://www.npmjs.com/package/yahoo-finance2)
- [yargs](https://www.npmjs.com/package/yargs)
## Installation
1. Clone the repository.
2. Run `npm install` to install the dependencies.
3. Run `npm link` to create a symlink to the CLI tool.
4. Run `fm --help` to see the available commands.
## Usage
### Get Stock Information
To get the stock price for a specific symbol:
```sh
fm stock
```
### Save Stock to Watchlist
To save a stock to the watchlist:
```sh
fm stock --save
fm stock AAPL --save
```
### Clean Watchlist
To clean the watchlist:
```sh
fm clean
```