https://github.com/bittricky/candlestick-cli
Command line tool to view trading charts from the terminal 🕯️
https://github.com/bittricky/candlestick-cli
chalk cli cryptocurrency javascript meow nodejs npm-package pnpm
Last synced: 3 months ago
JSON representation
Command line tool to view trading charts from the terminal 🕯️
- Host: GitHub
- URL: https://github.com/bittricky/candlestick-cli
- Owner: bittricky
- License: mit
- Created: 2024-12-25T15:40:36.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-05T23:40:49.000Z (5 months ago)
- Last Synced: 2025-01-06T00:28:31.720Z (5 months ago)
- Topics: chalk, cli, cryptocurrency, javascript, meow, nodejs, npm-package, pnpm
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/candlestick-cli
- Size: 91.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Candlestick CLI
> Are you analyzing market trends or just trying to set the mood? Either way, here is the candlestick you need!
A command-line tool to view cryptocurrency trading charts directly in your terminal.
## ⚠️ Disclaimer:
#### The Risks of Trading Financial Securities
-------------
Swing trading, day trading, options, borrowing on margin, are all high-risk investment strategies that involve significant financial exposure and volatility. These trading methods require substantial market knowledge, rapid decision-making, and an thorough understanding of technical analysis tools. Without the right skills, traders can incur severe financial losses, sometimes exceeding their initial investments. Maybe even worse.
#### Limitations of This Tool
-------------
The candlestick-cli project is designed as a lightweight tool for identifying candlestick patterns in trading data. While it provides valuable insights for educational and exploratory purposes, it is not a comprehensive trading platform and lacks advanced features such as real-time data integration, algorithmic trading, or risk management utilities that are critical for competitive trading strategies.
For serious traders, leveraging professional-grade trading tools with robust analytics, risk controls, and real-time data feeds is essential. The candlestick-cli tool is best used for learning and as a supplementary utility. Always perform due diligence and consider consulting a [fiduciary](https://www.investopedia.com/terms/f/fiduciary.asp) before engaging in high-risk trading activities. Otherwise you're just gambling with extra steps. If your uncomfortable with trading your own hard earned money or don't know where to start. Seek advisement from a reputable investment management firm or follow a traditional [three-fund](https://www.bogleheads.org/wiki/Three-fund_portfolio) portfolio. Sometimes its about time in the market not trying to time the market.
#### ⚠️ Warning:
--------------
Past performance of any trading strategy, tool, or pattern does not guarantee future results. Trading involves substantial risk, and users should only trade with capital they can afford to lose. Greed isn't always good. Whether your in control of it or it has control over you. You'll eventually discover which is which.
## Features
- 📈 Real-time candlestick charts in ASCII art
- 🪙 List all available cryptocurrencies
- 💹 View top cryptocurrencies by market cap
- 📊 Customizable chart timeframes (minutes, hours, days)
- 🎨 Color-coded output for better visualization
## Installation
```bash
# Install globally using npm
npm install -g candlestick-cli
# Or using pnpm
pnpm add -g candlestick-cli
```
## Usage
```bash
# View Bitcoin chart (defaults to USD and 24h timeframe)
candlestick -c BTC
# View Ethereum chart in EUR
candlestick -c ETH -r EUR
# Customize timeframe
candlestick -c BTC -d 7 # 7 days
candlestick -c BTC -H 4 # 4 hours
candlestick -c BTC -m 30 # 30 minutes
# Customize chart dimensions
candlestick -c BTC -w 100 -h 30
# List all available cryptocurrencies
candlestick -l
# View top N cryptocurrencies by market cap
candlestick -t 10
# Hide chart legend
candlestick -c BTC --disable-legend
```
## API
This tool uses the [CryptoCompare API - Free Tier](https://min-api.cryptocompare.com/) to fetch cryptocurrency data. The following endpoints being used:
- `/data/all/coinlist` - Get list of all available coins
- `/data/top/mktcapfull` - Get top coins by market cap
- `/data/histominute` - Get minute-level OHLCV data
- `/data/histohour` - Get hour-level OHLCV data
- `/data/histoday` - Get day-level OHLCV data
The free tier includes:
- 100,000 calls per month
- Rate limit of 50 calls/second
- Access to all basic price and market data
No API key is required for basic usage. If you need higher rate limits or additional features, you can sign up for an API key at [CryptoCompare](https://www.cryptocompare.com/cryptopian/api-keys).
## Development
### Prerequisites
- Node.js (v16 or higher)
- pnpm (recommended) or npm
### Setup
```bash
# Clone the repository
git clone https://github.com/bittricky/candlestick.git
cd candlestick
# Install dependencies
pnpm install
# Run tests
pnpm test
# Run the CLI in development
pnpm start chart BTC
```
### Project Structure
```
candlestick/
├── src/
│ ├── api/ # API integration
│ ├── lib/ # Core functionality
│ └── __tests__/ # Unit tests
├── index.js # CLI entry point
└── package.json
```
### Running Tests
The project uses Vitest for testing. Run tests with:
```bash
# Run all tests
pnpm test
# Run tests in watch mode
pnpm test -- --watch
```
## License
MIT License - see the [LICENSE](LICENSE) file for details.
## Author
Mitul Patel - [mitulpa.tel](https://mitulpa.tel)