Pokedex CLI is a command-line application built in Golang that allows users to explore Pokémon data interactively. It fetches Pokémon details from an external API and provides various commands to search, list, and view Pokémon information.
- Search for Pokémon by name or ID
- List all Pokémon in a paginated format
- View detailed stats, abilities, and types of a Pokémon
- Caching mechanism to speed up repeated queries
- Simple and intuitive command-line interface
- Golang - The core language for development
- REST API - Fetching Pokémon data
Ensure you have the following installed:
- Go (v1.19+ recommended)
- Clone the repository:
git clone https://github.com/Prodigy00/pokedex-cli.git cd pokedex-cli
- Install dependencies:
go mod tidy
- Build the CLI application:
go build -o pokedex
- Run the application:
./pokedex
Command | Description |
---|---|
pokedex help |
Show available commands and usage |
pokedex list |
List Pokémon with pagination |
pokedex info <name> |
Get details about a specific Pokémon |
pokedex catch <name> |
Attempt to catch a Pokémon and save it locally |
pokedex cache |
View cached Pokémon data |
- Get information about Pikachu:
./pokedex info pikachu
- List available Pokémon:
./pokedex list
- Catch a Pokémon:
./pokedex catch charmander
- Fork the repository.
- Create a new branch (
git checkout -b feature-name
). - Commit your changes (
git commit -m 'Add new feature'
). - Push to your branch (
git push origin feature-name
). - Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
For any inquiries or suggestions, feel free to reach out:
- GitHub: Prodigy00
Gotta catch 'em all! 🎮