Skip to content

Latest commit

 

History

History
executable file
·
88 lines (63 loc) · 2.61 KB

README.md

File metadata and controls

executable file
·
88 lines (63 loc) · 2.61 KB

Pokédex CLI

The Pocket Monster Index, now in your terminal!

Installation

The simpliest method of install is with the command runner just; Simply:

$> git clone https://github.com/calacuda/pokedex-cli.git
$> cd pokedex-cli
$> just install

However, if you don't have just installed; run:

$> git clone https://github.com/calacuda/pokedex-cli.git
$> cd pokedex-cli/
$> pip install -e .
$> mkdir -p ~/.cache/pokedex/resources/
$> cp -ur /tmp/pokedex-cli/pokedex/resources/* ~/.cache/pokedex/resources/

NOTE: you might need to add --break-system-packages to the above pip command (if your linux distribution's version of python requires it).

For the best output quality, please adjust the vertical line spacing in your terminal emulator until the block characters connect.

Supported Python Versions:

  • 3.8
  • 3.9
  • 3.10
  • 3.11
  • 3.12
  • 3.13
  • newer then 3.6 (probably)

Things That Don't Work

"-f page" doesn't work. but it didn't work in the original, so I have no way of knowing how it is supposed to work.

Usage

$ pokedex --help
Usage: main.py [OPTIONS] POKEMON

  Command-line interface for a quick Pokédex reference.

  Positional argument POKEMON can be either an id or a name, which has to be
  specified in the configured language.

Options:
  -s, --shiny                     Show shiny version of the Pokémon.
  -m, --mega                      Show Mega Evolution(s) if available.
  -l, --language LANGUAGE         Pokédex language to use.
  -pv, --pokedex-version VERSION  Pokédex version to use.
  -f, --format FORMAT             Output format (can be card, json, simple,
                                  line, page).
  --help                          Show this message and exit.

Screenshots

charzard.png swampert.png torterra.png

Acknowledgments

Pokémon © 2002-2016 Pokémon. © 1995-2016 Nintendo/Creatures Inc./GAME FREAK inc. TM, ® and Pokémon character names are trademarks of Nintendo.

No copyright or trademark infringement is intended in using Pokémon content in this project.