phux
reference

phux deprecations reference

Deprecated spellings the current binary still accepts, each pinned with its replacement and lifecycle releases; empty when nothing is currently deprecated.

evolving document
Full source summary

Deprecated spellings the current binary still accepts, each pinned with its replacement and lifecycle releases; empty when nothing is currently deprecated. Every row still parses, warns once on stderr with its replacement, is hidden from help and completions, and is scheduled for removal one release cycle or more after deprecation.

Every deprecated spelling this build of the binary still accepts. Each one parses with its full argument surface and runs its replacement’s implementation; the differences from the old behavior are exactly three, and a binary-level test pins each of them per row:

  1. one warning line on stderr naming the replacement — suppressed under --json, where stdout carries only the document and stderr is reserved for the one-line error contract;
  2. absence from --help;
  3. absence from the generated shell completions.

A deprecated spelling survives at least one full release cycle with the warning in place; the planned-removal release is the earliest it can disappear. Move scripts to the replacement before then.

No spelling is currently deprecated. When one is added to crate::deprecations::DEPRECATED, it appears here as a row of this table:

Deprecated spellingUse insteadDeprecated inPlanned removal

Removed

These spellings no longer parse. They are listed because a parse error names the replacement for them: clap’s nearest-match is computed on string distance and is usually wrong here (phux remote add resolves to rename), so each row below adds a hint: line naming the real migration. Rows age out once nobody is still upgrading past the release that removed them, after which clap’s ordinary message is the honest answer.

Removed spellingUse insteadRemoved in
phux remotephux hostv0.12.1
phux satellitephux host --role satellitev0.12.1
phux enrollphux host enrollv0.12.1
phux insert-pane --horizontalphux insert-pane --split horizontalv0.12.1
phux insert-pane --verticalphux insert-pane --split verticalv0.12.1
phux move-pane --horizontalphux move-pane --split horizontalv0.12.1
phux move-pane --verticalphux move-pane --split verticalv0.12.1
View exact source

On this page