massive-cli 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,8 +1,18 @@
1
- # Polygon (Massive) API CLI
1
+ # Massive(Polygon) API CLI
2
2
 
3
- A CLI tool for accessing [Polygon.io](https://polygon.io) financial data (Stocks, Crypto, Forex, Options, Indices) using [Bun](https://bun.sh).
3
+ A CLI tool for accessing [Massive(Polygon)](https://massive.com) financial data (Stocks, Crypto, Forex, Options, Indices) using [Bun](https://bun.sh).
4
4
 
5
- ## Setup
5
+ ## Usage
6
+
7
+ ### Via NPX (Recommended)
8
+
9
+ Run commands directly without installing:
10
+
11
+ ```bash
12
+ npx --yes massive <command> [options]
13
+ ```
14
+
15
+ ### Local Installation
6
16
 
7
17
  1. **Install Dependencies:**
8
18
  ```bash
@@ -10,7 +20,10 @@ A CLI tool for accessing [Polygon.io](https://polygon.io) financial data (Stocks
10
20
  ```
11
21
 
12
22
  2. **Configure API Key:**
13
- Create a `.env` file in the root directory:
23
+ ```bash
24
+ export POLY_API_KEY=your_api_key_here
25
+ ```
26
+ or create a .env file in the root directory:
14
27
  ```
15
28
  POLY_API_KEY=your_api_key_here
16
29
  ```
@@ -20,20 +33,6 @@ A CLI tool for accessing [Polygon.io](https://polygon.io) financial data (Stocks
20
33
  bun run build
21
34
  ```
22
35
  This generates the bundled CLI in `dist/cli.js`.
23
-
24
- ## Usage
25
-
26
- ### Via NPX (Recommended)
27
-
28
- Run commands directly without installing:
29
-
30
- ```bash
31
- npx massive <command> [options]
32
- ```
33
- *(Requires Bun to be installed)*
34
-
35
- ### Local Installation
36
-
37
36
  Run commands using the built CLI:
38
37
 
39
38
  ```bash
@@ -44,20 +43,20 @@ bun dist/cli.js <command> [options]
44
43
 
45
44
  **Stocks:**
46
45
  ```bash
47
- npx massive stocks-aggs --ticker AAPL --from 2023-01-01 --to 2023-01-31
46
+ npx --yes massive stocks-aggs --ticker AAPL --from 2023-01-01 --to 2023-01-31
48
47
  ```
49
48
 
50
49
  **Crypto:**
51
50
  ```bash
52
- npx massive crypto-snapshot --ticker X:BTCUSD
51
+ npx --yes massive crypto-snapshot --ticker X:BTCUSD
53
52
  ```
54
53
 
55
54
  **Market Status:**
56
55
  ```bash
57
- npx massive market-status
56
+ npx --yes massive market-status
58
57
  ```
59
58
 
60
59
  Use `--help` to see all available commands:
61
60
  ```bash
62
- npx massive --help
61
+ npx --yes massive --help
63
62
  ```