Skip to content

Configuration

~/.planx/config.json, seeded on first use. There is one key.

jsonc
{
  "format_version": 1,
  "render": "rich"
}
KeyTypeDefaultMeaning
renderrich | plain"rich"Default rendering for diff and show. --plain and --rich override it per command.

There is no planx config command. One key in a two-line file is a text editor's job, and a command to set it would be a bigger surface than the thing it sets.

What is not configuration

~/.planx/update.json sits beside it and is a cache, not a setting:

jsonc
{
  "format_version": 1,
  "latest": "0.5.0",
  "checked_at": "2026-08-05T21:11:04.000Z"
}

It is what the last background check found on npm, and the only reason the update notice can appear without any command waiting on the network. Deleting it costs one check. Editing it is pointless — the next check overwrites it.

What used to be here

  • mouse, which turned on wheel scrolling in the review at the cost of the terminal's own click-and-drag text selection. Wheel scrolling is gone: an append-only render cannot host a moving cursor, boxes that grow as you type, or folds, so there was nothing on the other side of the trade.
  • agents, an argv registry that existed so planx could spawn an agent for you. It does not: it prints a command and you run it where you already are.

Environment

VariableEffect
PLANX_DIRUse a different store. --dir takes precedence.
PLANX_NO_POSTINSTALLStop npm running add-skills after an install.
PLANX_NO_UPDATE_CHECKNever check npm for a newer planx. CI does this too.
PLANX_DEBUGPrint stack traces on error.
NO_COLORDisable ANSI colour, per no-color.org.
FORCE_COLORForce colour on when not a TTY.

MIT licensed.