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.

This guide walks you through the core PokeDo loop: create a task, complete it, catch a Pokemon, and check your progress. If you haven’t installed PokeDo yet, start with Installation.

1. Initialize your profile

pokedo init --name "Ash" --quick
This creates your trainer profile and downloads Gen 1 Pokemon data (151 Pokemon). The --quick flag speeds up the first run significantly.

2. Add a task

pokedo task add "Read for 20 minutes" --category learning --difficulty easy
Tasks have six categories (work, exercise, learning, personal, health, creative) and four difficulty levels (easy, medium, hard, epic). Category affects which Pokemon types you encounter; difficulty affects Pokemon rarity and XP rewards.

3. Complete the task

pokedo task complete 1
Completing a task has a ~70% base chance to trigger a Pokemon encounter. You’ll see the encounter result in the terminal — along with any XP gained and streak updates.
If no encounter triggers, keep completing tasks. The encounter rate increases with task difficulty and your current daily streak.

4. Check your dashboard

pokedo
Running pokedo without arguments shows your dashboard: trainer level, XP, streak, Pokemon count, pending tasks, and your active team.

5. View your Pokemon

pokedo team
pokedo pokemon box
pokedo pokedex
  • pokedo team — your active team of up to 6 Pokemon
  • pokedo pokemon box — all Pokemon you’ve caught
  • pokedo pokedex — all species you’ve seen or caught

6. Log your wellbeing

pokedo mood 4 --note "Productive day"
pokedo sleep 8 --quality 4
pokedo water --glasses 8
Wellbeing entries affect gameplay: good sleep boosts catch rates, 8 glasses of water unlocks Water-type bonuses, and meditation increases Psychic/Fairy encounter rates.

7. Try the TUI

pokedo tui
The interactive TUI dashboard gives you a full graphical view of your trainer profile, team, and tasks with keyboard navigation. Press t to open task management, p to switch profiles, and q to quit.

Next steps

Task management

Recurring tasks, priorities, due dates, and categories

Pokemon system

EV/IV training, evolution, sprites, and your Pokedex

Wellbeing tracking

All wellbeing commands and their gameplay bonuses

Command reference

Every command, flag, and option documented

Build docs developers (and LLMs) love