Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tldrwtf/pokedo/llms.txt

Use this file to discover all available pages before exploring further.

PokeDo is installed from source using pip. The setup process downloads Pokemon data from PokeAPI and creates a local SQLite database in ~/.pokedo/.

​
Requirements

PokeDo requires Python 3.10 or higher and pip. It works on macOS, Linux, and Windows (WSL recommended on Windows).
1

Clone the repository

git clone https://github.com/tldrwtf/pokedo.git
cd pokedo
2

Create a virtual environment (recommended)

python -m venv venv
source venv/bin/activate
3

Install PokeDo

pip install -e .
This installs both the pokedo and pd commands.
4

Initialize your trainer profile

pokedo init --name "Ash" --quick
The --quick flag initializes Gen 1 only (151 Pokemon) for a faster first-time setup. See full initialization options below.

​
Initialization options

The pokedo init command downloads Pokemon data from PokeAPI and creates your trainer profile. You only need to run this once.
FlagDescriptionExample
--nameYour trainer name (default: “Trainer”)--name "Ash"
--quickGen 1 only — 151 Pokemon, fastest setup--quick
--gen NInitialize a specific generation (1–9)--gen 3
--concurrency NParallel PokeAPI requests (default: 10, max: 50)--concurrency 20
For the fastest first-time experience, use --quick to start with Gen 1. You can add more generations later by running pokedo init again with --gen N.

​
Development install

To run tests or contribute, install with dev dependencies: 
pip install -e ".[dev]"
This adds pytest, black, ruff, isort, and pytest-asyncio.

​
Verify installation

pokedo version
pokedo --help
If the pokedo command is not found, ensure your virtual environment is activated and that pip install -e . completed successfully. You can also run python -m pokedo as an alternative entry point.

Build docs developers (and LLMs) love

Get started for freeTalk to us