stock-analysis-cli

Stock Analysis Command Line Tool written in Node.js/TypeScript

Setup

• Set FMP_API_KEY in environment matching the API key retrieved from https://financialmodelingprep.com/developer/docs/

• Usage
• Commands

Usage

$ npm install -g stock-analysis-cli
$ sac COMMAND
running command...
$ sac (-v|--version|version)
stock-analysis-cli/0.1.1-dev.0 linux-x64 node-v13.12.0
$ sac --help [COMMAND]
USAGE
  $ sac COMMAND
...

Commands

• sac help [COMMAND]
• sac snapshot SYMBOL
• sac status

sac help [COMMAND]

display help for sac

USAGE
  $ sac help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sac snapshot SYMBOL

returns the current name (if present), price and change for a symbol

USAGE
  $ sac snapshot SYMBOL

ARGUMENTS
  SYMBOL  the ticker symbol, use `search` if unsure

OPTIONS
  -d, --delay=delay  [default: 5] determines how long to wait before updating again
  -r, --repeat       automatically returns a new snapshot per delay window

See code: src/commands/snapshot.ts

sac status

returns the status of the Stock Analysis API and external services

USAGE
  $ sac status

See code: src/commands/status.ts