https://github.com/digitalghost-dev/poke-cli
A hybrid CLI/TUI tool written in Go for viewing Pokémon data from the terminal!
https://github.com/digitalghost-dev/poke-cli
charm charmbracelet cli data go pokemon terminal terminal-based tui
Last synced: 3 days ago
JSON representation
A hybrid CLI/TUI tool written in Go for viewing Pokémon data from the terminal!
- Host: GitHub
- URL: https://github.com/digitalghost-dev/poke-cli
- Owner: digitalghost-dev
- License: mit
- Created: 2024-05-29T17:24:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-14T22:04:43.000Z (12 days ago)
- Last Synced: 2026-01-17T01:56:56.123Z (10 days ago)
- Topics: charm, charmbracelet, cli, data, go, pokemon, terminal, terminal-based, tui
- Language: Go
- Homepage:
- Size: 17 MB
- Stars: 51
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Pokemon CLI
`poke-cli` is a hybrid of a classic CLI and a modern TUI tool for viewing VG and TCG data about Pokémon!
View the [documentation](https://docs.poke-cli.com) on the data infrastructure in [card_data/](https://github.com/digitalghost-dev/poke-cli/tree/main/card_data) if you're interested.
* [Demo](#demo)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Tested Terminals](#tested-terminals)
---
## Demo
### Video Game Data
### Trading Card Game Data
---
## Installation
* [Homebrew](#homebrew)
* [Scoop](#scoop)
* [Linux Packages](#linux-packages)
* [Docker Image](#docker-image)
* [Binary](#binary)
* [Source](#source)
### Homebrew
1. Install the Cask:
```bash
brew install --cask digitalghost-dev/tap/poke-cli
````
2. Verify installation:
```bash
poke-cli -v
```
### Scoop
1. Add the bucket:
```bash
scoop bucket add digitalghost https://github.com/digitalghost-dev/scoop-bucket.git
```
2. Install poke-cli:
```bash
scoop install poke-cli
```
3. Verify installation:
```bash
poke-cli -v
```
### Linux Packages
[](https://cloudsmith.com)
This package repository is generously hosted by Cloudsmith.
Cloudsmith is a fully cloud-based service that lets you easily create, store, and share packages in any format, anywhere.
1. Run the **Repository Setup** script first for the correct Linux distribution.
2. Run the corresponding **Installation Command** afterward.
| Package Type | Distributions | Repository Setup | Installation Command |
|:------------:|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|
| `apk` | Alpine | `sudo apk add --no-cache bash && curl -1sLf 'https://dl.cloudsmith.io/basic/digitalghost-dev/poke-cli/setup.alpine.sh' \| sudo -E bash` | `sudo apk add poke-cli --update-cache` |
| `deb` | Ubuntu, Debian | `curl -1sLf 'https://dl.cloudsmith.io/public/digitalghost-dev/poke-cli/setup.deb.sh' \| sudo -E bash` | `sudo apt-get install poke-cli` |
| `rpm` | Fedora, CentOS, Red Hat, openSUSE | `curl -1sLf 'https://dl.cloudsmith.io/public/digitalghost-dev/poke-cli/setup.rpm.sh' \| sudo -E bash` | `sudo yum install poke-cli` |
### Docker Image
1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/).
2. Once installed, use the command below to pull the image and run the container!
* `--rm`: Automatically remove the container when it exits.
* Optional.
* `-i`: Interactive mode, keeps STDIN open for input.
* Necessary.
* `-t`: Allocates a terminal (TTY) for a terminal-like session.
* Necessary.
3. Choose how to interact with the container:
* Run a single command and exit:
```bash
docker run --rm -it digitalghostdev/poke-cli:v1.8.7 [subcommand] [flag]
```
* Enter the container and use its shell:
```bash
docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.8.7 -c "cd /app && exec sh"
# placed into the /app directory, run the program with './poke-cli'
# example: ./poke-cli ability swift-swim
```
### Binary
1. Head to the [releases](https://github.com/digitalghost-dev/poke-cli/releases) page of the project.
2. Choose a version to download. The latest is best.
3. Choose an operating system and click on the matching zipped folder to start the download.
4. Extract the folder. The tool is ready to use.
5. Either change directories into the extracted folder or move the binary to a chosen directory.
6. Run the tool!
> [!IMPORTANT]
> For macOS, you may have to allow the executable to run as it is not signed. Head to System Settings > Privacy & Security > scroll down and allow executable to run.
View Image of Settings
#### Example usage
```bash
# Windows
.\poke-cli.exe pokemon charizard --types --abilities
# Unix
.\poke-cli ability airlock --pokemon
```
### Source
1. Run the following command:
```bash
go install github.com/digitalghost-dev/poke-cli@latest
```
2. The tool should be ready to use if `$PATH` is set up.
---
## Usage
By running `poke-cli [-h | --help]`, it'll display information on how to use the tool or check out the [docs](https://docs.poke-cli.com/)!
```
╭───────────────────────────────────────────────────────────────╮
│Welcome! This tool displays data related to Pokémon! │
│ │
│ USAGE: │
│ poke-cli [flag] │
│ poke-cli [flag] │
│ poke-cli [flag] │
│ │
│ FLAGS: │
│ -h, --help Shows the help menu │
│ -l, --latest Prints the latest version available │
│ -v, --version Prints the current version │
│ │
│ COMMANDS: │
│ ability Get details about an ability │
│ berry Get details about a berry │
│ card Get details about a TCG card │
│ item Get details about an item │
│ move Get details about a move │
│ natures Get details about all natures │
│ pokemon Get details about a Pokémon │
│ search Search for a resource │
│ speed Calculate the speed of a Pokémon in battle │
│ types Get details about a typing │
│ │
│ hint: when calling a resource with a space, use a hyphen │
│ example: poke-cli ability strong-jaw │
│ example: poke-cli pokemon flutter-mane │
│ │
│ ↓ ctrl/cmd + click for docs/guides │
│ docs.poke-cli.com │
╰───────────────────────────────────────────────────────────────╯
```
---
## Roadmap
Below is a list of the planned/completed commands and flags:
- [x] `ability`: get data about an ability.
- [x] `-p | --pokemon`: display Pokémon that learn this ability.
- [x] `berry`: get data about a berry.
- [ ] `card`: get data about a TCG card.
- [x] add mega evolution data
- [x] add scarlet & violet data
- [x] add sword & shield data
- [ ] add sun & moon data
- [ ] add x & y data
- [x] `item`: get data about an item.
- [x] `move`: get data about a move.
- [ ] `-p | --pokemon`: display Pokémon that learn this move.
- [x] `natures`: get data about natures.
- [x] `pokemon`: get data about a Pokémon.
- [x] `-a | --abilities`: display the Pokémon's abilities.
- [x] `-d | --defense`: display the Pokémon's type defences.
- [x] `-i | --image`: display a pixel image of the Pokémon.
- [x] `-s | --stats`: display the Pokémon's base stats.
- [x] `-m | --moves`: display learnable moves.
- [ ] `search`: search for a resource
- [x] `ability`
- [ ] `berry`
- [ ] `item`
- [x] `move`
- [x] `pokemon`
- [x] `speed`: compare speed stats between two Pokémon.
- [x] `types`: get data about a specific typing.
---
## Tested Terminals
| Terminal | OS | Status | Issues |
|-------------------|:-------------------------:|:------:|----------------------------------------------------------------------------------------------|
| Alacritty | macOS, Ubuntu,
Windows | 🟡 | - Does not support sixel for TCG images. |
| Ghostty | macOS | 🟡 | - Does not support sixel for TCG images. |
| HyperJS | macOS | 🟡 | - Does not support sixel for TCG images. |
| iTerm2 | macOS | 🟢 | - None |
| Built-in Terminal | Ubuntu, Debian,
Fedora | 🟡 | - Does not support sixel for TCG images. |
| Built-in Terminal | Alpine | 🟡 | - Some colors aren't supported.
- `pokemon --image=xx` flag pixel issues. |
| Built-in Terminal | macOS | 🟠 | - Does not support sixel for TCG images.
- `pokemon --image=xx` flag pixel issues. |
| Foot | Ubuntu | 🟢 | - None |
| Tabby | Ubuntu | 🟢 | - None |
| WezTerm | macOS, Windows | 🟡 | - Windows version has issues with displaying TCG images. |
| Built-in Terminal | Windows | 🟢 | - None |