https://github.com/raphaelmansuy/matcha-stock

A final stage of a tutorial to create a CLI command with OCLIF in Typescript
https://github.com/raphaelmansuy/matcha-stock

cli nodejs oclif typescript yahoo-finance

Last synced: 8 months ago
JSON representation

A final stage of a tutorial to create a CLI command with OCLIF in Typescript

• Host: GitHub
• URL: https://github.com/raphaelmansuy/matcha-stock
• Owner: raphaelmansuy
• Created: 2021-01-20T05:12:20.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-27T21:22:25.000Z (about 2 years ago)
• Last Synced: 2024-10-30T05:25:36.263Z (12 months ago)
• Topics: cli, nodejs, oclif, typescript, yahoo-finance
• Language: TypeScript
• Homepage:
• Size: 1.05 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# matcha-stock

A command to get stock information. Created with ❤️ by [Elitizon](https://www.elitizon.com).

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/matcha-stock.svg)](https://npmjs.org/package/matcha-stock)

[![Downloads/week](https://img.shields.io/npm/dw/matcha-stock.svg)](https://npmjs.org/package/matcha-stock)

[![License](https://img.shields.io/npm/l/matcha-stock.svg)](https://github.com/raphaelmansuy/matcha-stock/blob/master/package.json)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fraphaelmansuy%2Fmatcha-stock.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fraphaelmansuy%2Fmatcha-stock?ref=badge_shield)

- [matcha-stock](#matcha-stock)

- [Usage](#usage)

- [Example](#example)

# Usage

```sh-session

$ npm install -g matcha-stock

$ matcha-stock -h

A simple command to retrieve stock information from Yahoo Finance.

USAGE

  $ matcha-stock

OPTIONS

  -h, --help         show CLI help

  -s, --symbol=MSFT  (required) stock symbol to retrieve

  -v, --version      show CLI version

DESCRIPTION

  A simple command to retrieve stock information from Yahoo Finance.

    Created with ❤️ by Elitizon (https://www.elitizon.com)

```

# Example

```bash

$  npx matcha-stock -s=MSFT

┌───────────────────────────────────┬─────────────────────────┐

│              (index)              │         Values          │

├───────────────────────────────────┼─────────────────────────┤

│             language              │         'en-US'         │

│              region               │          'US'           │

│             quoteType             │        'EQUITY'         │

│          quoteSourceName          │     'Delayed Quote'     │

│            triggerable            │          true           │

│             currency              │          'USD'          │

│    firstTradeDateMilliseconds     │      511108200000       │

│             priceHint             │            2            │

│            marketState            │       'POSTPOST'        │

│      postMarketChangePercent      │       0.31417143        │

```

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fraphaelmansuy%2Fmatcha-stock.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fraphaelmansuy%2Fmatcha-stock?ref=badge_large)