Skip to content

Latest commit

 

History

History
124 lines (101 loc) · 5.54 KB

README.md

File metadata and controls

124 lines (101 loc) · 5.54 KB
Raw
pokemon-logo

Pokémon CLI

version-label docker-image-size ci-status-badge
tests-label go-version codecov

Overview

A CLI tool for viewing data about Pokémon from your terminal! I am new to writing Go and taking my time in building this project.

My aim is to have four commands finished for v1.0.0. Read more in the Roadmap section.

Demo

demo

Install

Binary

Download a pre-built binary

  1. Head to the releases page of the project.
  2. Choose a version to download. The latest is best.
  3. Choose an operating system and click on the matching zipped folder to start the download.
  4. Extract the folder. The tool is ready to use.
  5. Either change directories into the extracted folder or move the binary to a chosen directory.
  6. Run the tool!

Important

For macOS, you may have to allow the executable to run as it is not signed. Head to System Settings > Privacy & Security > scroll down and allow executable to run.

View Image of Settings

settings

Example usage

# Windows
.\poke-cli.exe pokemon charizard --types --abilities
 
# Unix
.\poke-cli pokemon vespiquen -t -a

Docker Image

Use a Docker Image

  1. Install Docker Desktop.
  2. Once installed, use the command below to pull the image and run the container!
    • --rm: Automatically remove the container when it exits.
      • Optional.
    • -i: Interactive mode, keeps STDIN open for input.
      • Necessary.
    • -t: Allocates a terminal (TTY) for a terminal-like session.
      • Necessary.
docker run --rm -i -t digitalghostdev/poke-cli:v0.9.2 <command> [subcommand] flag]

Go Install

If you have Go already, install the executable yourself

  1. Run the following command: 
    go install github.com/digitalghost-dev/poke-cli@latest
  2. The tool is ready to use!

Usage

By running poke-cli [-h | --help], it'll display information on how to use the tool.

╭────────────────────────────────────────────────────────╮
│Welcome! This tool displays data related to Pokémon!    │
│                                                        │
│ USAGE:                                                 │
│    poke-cli [flag]                                     │
│    poke-cli <command> [flag]                           │
│    poke-cli <command> <subcommand> [flag]              │
│                                                        │
│ FLAGS:                                                 │
│    -h, --help      Shows the help menu                 │
│    -l, --latest    Prints the latest version available │
│    -v, --version   Prints the current version          │
│                                                        │
│ AVAILABLE COMMANDS:                                    │
│    pokemon         Get details of a specific Pokémon   │
│    types           Get details of a specific typing    │
╰────────────────────────────────────────────────────────╯

Roadmap

The architecture behind how the tool works is straight forward.

  1. Commands indicate which data endpoint to focus on.
  2. Flags provide more information and can be all stacked together or chosen.

Planned for Version 1.0.0

Not 100% up-to-date, may add or remove some of these choices

  • pokemon: get data about a specific Pokémon.
    • -a | --abilities: display the Pokémon's abilities.
    • -s | --stats: display the Pokémon's base stats.
    • -t | --types: display the Pokémon's typing.
    • -m | --moves: display learnable moves.
  • types: get data about a specific typing.
  • ability: get data about a specific ability.
    • -p | --pokemon: display Pokémon that learn this ability.
  • move: get data about a specific move.
    • -p | --pokemon: display Pokémon that learn this move.