Pokesearch

Work in progress

To-do

• Usage details
• Finish README.md
• Research release details
• Commands for items & locations
• Documentation

Usage

• pokesearch config gen [genNumber] - Set a default gen for learnsets
  • Ex: pokesearch config gen 4 - Set default gen to IV
• pokesearch pokemon [pokemonName] [flags] - Search info for a specified Pokemon
  • Ex: pokesearch pokemon kadabra -elst -g 5
    • Get Bulbapedia links for Kadabra's Evolution, Gen V Learnset, Stats, and Type Effectiveness

🚀 Getting Started

Installation

• Download Go
• Install Cobra with go get -u github.com/spf13/cobra
  • To ensure cobra works in the command line, make sure $GOPATH/bin is in your $PATH. You can check your $GOPATH by running go env GOPATH

⚙️ Workflow Details

Development Process

1. Edit the root command & initialization in cmd/root.go
2. Edit commands in the cmd directory
   • To add a command, use cobra add [command]
   • To add a subcommand with an existing command as a parent, use cobra add [newCmd] -p [parentCmd]Cmd
     • Ex: To make app config create a command, run cobra add create -p 'configCmd'
3. Edit util functions in the util directory
4. Run go run main.go [..commands] test your commands

Build (Docs: https://go.dev/doc/tutorial/compile-install)

1. Run go build
2. Run go install
   • If $GOPATH/bin is in your $PATH, you should be able to run your executable anywhere!

✔️ Current Release Details

Packages Included

• Cobra - CLI Building
• Viper - CLI Config Building

📅 Future Release Plans

• Other database sources

🗒️ Additional Resources

Best Practices

• Effective Go

Documentation

• A Tour of Go (Go Basics)
• Go By Example
• Go Docs
• Cobra User Guide
• Viper User Guide