PKHeX.CLI

PKHeX CLI

This is a cross platform Command Line Interface (CLI) tool for interacting with Pokémon save files. It provides various functionalities to manage and modify Pokémon save data.

Features

• Load Save File: Load a Pokémon save file from a specified path.
• View Trainer Info: View information about the trainer in the save file.
• View/Edit Inventory: View and edit the inventory of the trainer.
• View/Edit Party: View and edit your party.
• View/Edit Pokemon Box: View and edit all pokemons in your box.
• Backups: When exiting the program, if changes were made, a backup will be created.

Installation

Homebrew (MacOS/Linux)

brew tap arleypadua/homebrew-pkhex-cli
brew install pkhex-cli

Script (MacOS/Linux)

curl -sL https://raw.githubusercontent.com/arleypadua/PKHeX.Everywhere/main/install.sh | sudo bash

Compatibility with batocera

PKHeX.CLI is compatible with batocera:

1. Make sure you can access batocera with SSH. (Details here).
2. Open an ssh session: ssh root@batocera the default password is usually linux
3. run curl -sL https://raw.githubusercontent.com/arleypadua/PKHeX.Everywhere/main/install.sh | bash
   • note that because we are accessing as root there's no need to run sudo bash
4. You should be able to use it as stated here.

Chocolatey (Windows)

1. Make sure chocolatey is properly installed
2. Open powershell as administrator
3. Run the following:

choco install pkhex-cli

Manual download

1. Download the latest version for your system here
2. Put the file somewhere that's visible from your PATH directory

Verify the installation with

pkhex-cli --version

should print out

PKHeX CLI: x.y.z

Usage

pkhex-cli /path/to/savefile.bin

Command Line Options

• savefile: (Optional) The path to the save file. Defaults to "./data/savedata.bin".
• --version: Shows the version

Building

Prerequisites

• .NET Core SDK 8.x

Steps

1. Clone this repository to your local machine.
2. Make sure that the submodules are also cloned: git submodule update --init --recursive
3. Navigate to the project directory.
4. Compile the program using dotnet build.
5. Run the program using dotnet run -- [options].

Example

dotnet run --project ./src/PKHeX.CLI ./src/PKHeX.CLI/data/savedata.bin

Releasing

1. Go to the Release workflow
2. Choose whether it is a major, minor or patch bump
3. Run it
4. By the end of the workflow, you should have a new Release

Credits

This CLI tool utilizes the following libraries:

• PKHeX.Core for interacting with Pokémon save files.
• Spectre.Console for enhancing the command line interface.