@nepse-toolkit/cli

CLI for Nepal Stock Exchange market data, analysis, screening, backtesting, and local operations.

Part of the nepse-toolkit monorepo.

Overview

22 subcommands
Supports JSON output via --json on command surfaces
Covers market data, stock analysis, opportunities, portfolio, alerts, sync, and provider telemetry ops

Install

npm install -g @nepse-toolkit/cli

Run without installing:

npx @nepse-toolkit/cli market

Quick Start

nepse market
nepse stock NABIL -a
nepse opportunities
nepse providers
nepse telemetry --hours 24 --top 10

Command Groups

Market and index: market, holidays, breadth, market-history, reference, participants, media, marcap, sectors
Stock and screening: stock, screen, opportunities, compare, floorsheet, ipo
Portfolio ops: watchlist, portfolio, alert
Strategy and ops: backtest, providers, telemetry, sync

Exact Usage

nepse market [--sentiment] [--json]
nepse holidays [--year YYYY] [--json]
nepse breadth [--indexId N] [--json]
nepse market-history [--fromDate YYYY-MM-DD] [--toDate YYYY-MM-DD] [--page N] [--size N] [--json]
nepse reference [--resource <name>] [--page N] [--size N] [--detailId N] [--debentureType TYPE] [--json]
nepse participants [--type member|dealer] [--page N] [--size N] [--json]
nepse media [--type press-release|company-news|investor-awareness|companies-disclosure] [--page N] [--size N] [--json]
nepse marcap [--fromDate YYYY-MM-DD] [--toDate YYYY-MM-DD] [--page N] [--size N] [--json]
nepse stock <SYMBOL> [-a|--analysis] [-h|--history] [--news] [--metadata] [--disclosures] [--fromDate YYYY-MM-DD] [--toDate YYYY-MM-DD] [--page N] [--size N] [--json]
nepse screen [-s|--sector <sector>] [-v|--minVolume <n>] [--gainers] [--losers] [-n|--limit <n>] [--json]
nepse opportunities [-s|--strategy <strategy>] [-n|--limit <n>] [--json]
nepse compare <SYMBOL> [SYMBOL ...] [--json]
nepse floorsheet <SYMBOL> [-d|--date YYYY-MM-DD] [-b|--brokers] [-n|--limit <n>] [--json]
nepse sectors [--json]
nepse watchlist [-n|--name <name>] [-a|--add <symbol>] [-r|--remove <symbol>] [-l|--list] [--json]
nepse portfolio [--add -s <symbol> -q <qty> -p <price> -d <date>] [--remove <id>] [--json]
nepse alert [-s <symbol> --above <price> | -s <symbol> --below <price> | -r <id> | -c] [--json]
nepse backtest [-s|--strategy <name>] [-h|--holding <days>] [-c|--capital <npr>] [-p|--position <percent>] [--slippage <bps>] [--fee <percent>] [--maxPositions <n>] [--maxExposure <percent>] [--symbols <csv>] [--json]
nepse providers [--json]
nepse telemetry [--limitEndpoints N] [--hours N] [--top N] [--json]
nepse sync [--json]
nepse ipo [--fromDate YYYY-MM-DD] [--toDate YYYY-MM-DD] [--page N] [--size N] [--json]

Development

bun --filter @nepse-toolkit/cli run build
bun --filter @nepse-toolkit/cli run typecheck
bun test packages/cli/tests/

License

MIT