# @kairoot/psei-cli

> A simple cli for fetching PH stock exchange data

Latest version **1.0.2** (published 2023-09-22) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @kairoot/psei-cli
pnpm add @kairoot/psei-cli
yarn add @kairoot/psei-cli
bun add @kairoot/psei-cli
```

Provides the command `psei-cli`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-09-22 |
| First published | 2023-09-22 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 20.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Brian Calma |
| Maintainers | kairoot |
| Keywords | cli, npmtool, stocks, pse, bullish, stockmarket, exchange, bearish, candle, trading |

## Links

- npm: https://www.npmjs.com/package/@kairoot/psei-cli
- Repository: https://github.com/briancalma/psei-cli
- Homepage: https://github.com/briancalma/psei-cli#readme
- Issues: https://github.com/briancalma/psei-cli/issues
- npm.io page: https://npm.io/package/@kairoot/psei-cli

## Dependencies (7)

- [ora](https://npm.io/package/ora.md) ^7.0.1
- [axios](https://npm.io/package/axios.md) ^1.5.0
- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [figlet](https://npm.io/package/figlet.md) ^1.6.0
- [moment](https://npm.io/package/moment.md) ^2.29.4
- [commander](https://npm.io/package/commander.md) ^11.0.0
- [cli-table3](https://npm.io/package/cli-table3.md) ^0.6.3

## 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

- 1.0.2 (latest) — 2023-09-22
- 1.0.1 — 2023-09-22
- 1.0.0 — 2023-09-22

## README

# psei-cli

[![npm version](https://badge.fury.io/js/@kairoot%2Fpsei-cli.svg)](https://badge.fury.io/js/@kairoot%2Fpsei-cli)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

A simple command-line tool for fetching Philippine stock market data. Built with the [Phisix API](https://github.com/phisix-org/phisix) and inspired by [pse-tracker-cli](https://github.com/ianvizarra/pse-tracker-cli).

## Table of Contents

- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
- [Sources](#sources)
- [Author](#author)

## Features

- Fetch real-time and historical stock data from the Philippine Stock Exchange.
- User-friendly command-line interface.
- Highly customizable queries.

## Prerequisites

- Node.js: You'll need to have Node.js installed to use `psei-cli`. Download it [here](https://nodejs.org/en/download/current).

## Installation

After installing Node.js, you can install `psei-cli` globally using the following command:

```bash
npm install -g @kairoot/psei-cli
```

## Usage

After installation, you can fetch stock data using the following commands:

```bash
# To get stock data
psei-cli get-stock <symbol>

# Example
psei-cli get-stock JFC

# To view help
psei-cli --help

# To view command-specific help
psei-cli [command] --help
```

## License

`psei-cli` is licensed under the [GNU General Public License v3](https://opensource.org/licenses/GPL-3.0).

## Sources

- API from [Phisix API](https://github.com/phisix-org/phisix)

## Author

- Developed and maintained by Brian Calma.
- 📧 Email: [briancalmadevacc@gmail.com](mailto:briancalmadevacc@gmail.com)

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