Repository navigation
Home
Welcome to the paradox-toolkit-cli wiki!
pxtk provides standalone commands and local MCP tools for Paradox mod research, saved-file validation and content preparation. VS Code is optional. The CLI shares its parser, game profiles, documentation, Tiger helpers and texture codecs with the Paradox Modding Toolkit.
This wiki covers v0.2.1, with 21 MCP tools. It includes translation synchronization, symbol rename, precise definition editing, conflict reports, vanilla import, local release staging and migration catalog, routes and recipe previews.
Install pxtk-cli@0.2.1 from npm, or use the authenticated GitHub Packages mirror @jdeffner/pxtk-cli@0.2.1. Both provide pxtk. The release also provides a CLI tarball and SHA-256 checksums. The 0.1.0 release audit remains historical evidence for that version.
- Install or build pxtk.
- Select the game, mod and sources.
- Run
pxtk status --json, then search, inspect and read relevant source. - Preview a change, review its files and apply the same request with its token.
- Validate saved files and observe the intended behavior in the game.
The profiles include ck3, vic3 and eu5. Available scaffolds, validation and loading rules come from each profile. Selecting a profile does not certify every feature or game patch.
| Task | Page |
|---|---|
| Install, configure and run a first query | Getting Started |
| Set paths, dependency order and portable defaults | Configuration |
| Choose a command and understand its result | Command Reference |
| Connect an MCP client or use the portable skill | MCP and Agents |
| Preview edits, maintain localization and prepare images | Editing and Localization |
| Review ordered mods, copy vanilla files and stage a release | Conflicts, Import and Packaging |
| Discover migration recipes and review plans | Migrations |
| Diagnose incomplete checks and understand coverage | Troubleshooting and Limits |
| Build, test and update the shared core | Development |
Commands read saved files and cannot see unsaved editor buffers. Vanilla and dependency mods are read-only reference inputs. Writers preview by default; explicit write mode applies disk changes. A batch is not a filesystem transaction, so failures report completed files. Static checks and a successful launch do not establish gameplay behavior.
The package contains its compiled LSP, game data and licenses. It does not install a game or Tiger, and it makes no model API calls. MCP runs locally over stdio.
The release README and JSON/MCP protocol are the canonical references for 0.2.1.