# pokelookup [![Latest Version]][crates.io] [![Repo Version]][github] [![CI]][CI YAML]
[Latest Version]: https://img.shields.io/crates/v/pokelookup.svg
[crates.io]: https://crates.io/crates/pokelookup
[Repo Version]: https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fjemarq04%2Fpokelookup%2Frefs%2Fheads%2Fmain%2FCargo.toml&query=package.version&prefix=v&label=repo
[github]: https://github.com/jemarq04/pokelookup
[CI]: https://github.com/jemarq04/pokelookup/actions/workflows/ci.yml/badge.svg
[CI YAML]: https://github.com/jemarq04/pokelookup/actions/workflows/ci.yml
This is a package that gives an executable to help look up Pokemon details using [PokeAPI](https://pokeapi.co/) using the
[`rustemon`](https://crates.io/crates/rustemon) wrapper. The command allows for quick look-up of types, abilities, egg groups, and more.
## Usage
After installing the package, run `pokelookup --help` to see all possible subcommands and options. Note that since this package uses
PokeAPI to get its information, Pokemon will need qualifiers if there are multiple forms. For example, to look up the types for Toxtricity,
you will need to specify which form (Amped or Low-Key). The `pokelookup list` subcommand is a way to look up varieties of a given Pokemon
species for help finding the needed identifier.
## Caching
By default, `pokelookup` will create and use a cache for API requests using the `rustemon` crate in the user's home directory. The specific
path is `~/.cache/pokelookup`. If you want to change that, use the `--cache-dir` option to specify the desired location.
## Features
By default, this package uses the `wrap_help` feature from [`clap`](https://crates.io/crates/clap) to wrap the help and usage printouts based on
the terminal's current width.
Additionally, there is a `web` feature which can be enabled which adds an additional `pokelookup search` subcommand. This subcommand will open pages
from [Serebii](https://www.serebii.net/) based on the query provided. To enable this, use `cargo install -F web` when installing the package.
## Contributing
Contributions and feedback is welcome! Feel free to open a PR or add an issue in the Issues tab.