Skip to content

A CLI tool written in Go that allows you to view data about Pokémon from the terminal.

Notifications You must be signed in to change notification settings

digitalghost-dev/poke-cli

Repository files navigation

pokemon-logo

Pokémon CLI

version-label docker-image-size
tests-label go-version

Overview

A CLI tool for viewing data about Pokémon from your terminal!

Install

Go Build

  1. Make sure Go is installed on your machine. This project uses v1.21.
  2. Clone the repository in a root directory: git clone https://github.com/digitalghost-dev/poke-cli.git
  3. Change directories into the poke-cli directory.
  4. Run go build -o poke-cli
  5. A binary will be created then the tool can be used! It can also be added to your path to run the binary from anywhere.

Docker

Use a Docker Image instead:

docker run --rm -it digitalghostdev/poke-cli:v0.2.0 [command] [flag]

Note

Currently working on more ways to distribute the binary.

Usage

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

Welcome! This tool displays data about a selected Pokémon in the terminal!
      
USAGE:
         poke-cli [flag]
         poke-cli [pokemon name] [flag]
         ----------
         Example: poke-cli bulbasaur or poke-cli flutter-mane --types
             
GLOBAL FLAGS:
         -h, --help      Shows the help menu

POKEMON NAME FLAGS:
         Add a flag after declaring a Pokémon's name for more details!
        --types

About

A CLI tool written in Go that allows you to view data about Pokémon from the terminal.

Topics

Resources

Stars

Watchers

Forks