koneko-cli
Version:
Your CLI for reading manga from the terminal
104 lines (64 loc) • 2.32 kB
Markdown
# 🌸 Koneko
**Koneko** is a fast, lightweight command-line tool built for manga lovers who want to explore, download, and read manga — all from the comfort of their terminal.
No installs. No clutter. Just run it and start exploring.
_Koneko CLI is your manga library, viewer, and downloader in one simple tool._
## 🚀 Features
- 📥 **Download Manga**
Save manga chapters locally for offline use.
- 📖 **Read Manga in Terminal**
Enjoy chapters right inside your CLI — clean and minimal.
- 🧾 **Manga Info Lookup**
Instantly fetch summaries, genres, and metadata.
- ⚡ **Fast, Minimal UX**
Runs directly with `npx`, optimized for speed and simplicity.
- 🔔 **Update Notifications**
Get notified when a newer version is released.
- 🔌 **Plugin Support**
Customize and extend Koneko with plugins created by the community or yourself.
## 🛠 Installation
Choose your path to manga enlightenment:
### 📦 Path 1: Install from NPM (Quick & Easy)
```bash
npm install -g koneko-cli
```
Then summon the Koneko beast:
```bash
koneko
```
Or run instantly without installing:
```bash
npx koneko-cli
```
### 🛠 Path 2: Build From Source (For Developers & Contributors)
1. Clone or download the repository.
2. Install the magical scrolls (aka dependencies):
```bash
npm install
```
3. Forge the CLI sword (build the project):
```bash
npm run build
```
4. Summon the Koneko beast:
```bash
koneko
```
5. (Optional but Legendary) Link it globally to use anywhere on your machine:
```bash
npm link
koneko
```
💬 Need help?
Just scream “Senpai!!” (or open an issue on GitHub — we’re watching 👀)
## 💬 Join Our Discord Community!
Want to chat, get help, or hang out with fellow Koneko fans?
Click below and join our Discord server!
[](https://discord.gg/menAVncm)