Add-ons/Toolbox/Commands

Lua add-on documentation: Toolbox overview · Add-on hub · Contribute or update documentation

Toolbox registers /toolbox and /tbx as equivalent chat commands. Entering either command alone opens settings. /toolbox commands prints the complete command list generated by the installed add-on's own command-registration table, making it the final authority when this page and a newer version differ.

Commands marked 1.8.0 are included in the current Community Addons package. Toolbox 1.9.0 adds the crafting-planner command family and the additional options identified below.

Help and configuration

Command	Purpose
/toolbox or /tbx	Open settings.
/toolbox help	Open the in-addon guide.
/toolbox docs	Toggle the guide window.
/toolbox commands	Print every registered command and its short help in chat.
/toolbox config	Toggle the settings window.
/toolbox settings	Show settings-file and setup actions; accepts save, reset, cancel, setups, export, import, delete, and share forms. On Lua API 39 or later, version 1.9.0 also provides backup, backups, and restore <number>.
/toolbox key	Show the current Toolbox key binding.
/toolbox version	Print the installed version and build, then open its changelog.
/toolbox welcome	Show the first-run welcome again; reset schedules it for the next reload.

Tracking commands

Command	Purpose
/toolbox xp	Toggle XP; accepts hud, window, compact, move [x y], and debug.
/toolbox xpdetailed	Toggle XP Detailed.
/toolbox reset	Start a new XP session.
/toolbox daily	Toggle Today; accepts hud, window, compact, and move [x y].
/toolbox loot	Toggle the Loot Tracker; accepts reset, today, and view choices. The older dailydetailed and dd names remain aliases.
/toolbox crafted	Open the Loot Tracker's crafting view.
/toolbox gathered	Open the Loot Tracker's gathering view.
/toolbox recipe <name>	Report a known recipe and its raw-material requirements as exposed by the game. Toolbox 1.8.0 expands the report on Lua API 37 clients with station, inventory, material-slot, and item-key information.

The Loot Tracker's advanced chat settings use the dd form documented by /toolbox commands, including include on|off and values on|off|refresh|test [item].

Toolbelt and HUD commands

Command	Purpose
/toolbox toolbelt	consumables|gear|target on|off, combat on|off, and move [x y].
/toolbox buffs	Toggle and configure buffs, grouping, muted effects, per-effect sounds, repeat suppression, countdown, replacement, dismissal, combat-only mode, and the buff block.
/toolbox buffalert	Set the expiration warning to 1–60 seconds, turn it on or off, or report its state.
off	Control the sound when a debuff lands.
/toolbox vitals	Configure health, focus, and Vigor bars, size, text, bars, background, flash threshold, replacement, Toolbelt attachment, and position.
/toolbox target	off to show the target's name above its bars; its Dark number-panel shade is set in the Toolbelt settings.
/toolbox consumables	Configure the consumables bar, categories, exclusions, additional names, icon limit, combat-only mode, Toolbelt attachment, and position.
/toolbox gear	List worn durability or configure the equipment bar, repair threshold, Toolbelt attachment, and position.
/toolbox skills	Configure the skill-activity strip, orientation, XP or level display, sounds, pause or resume training modes, and position.

Several older internal labels use glue where the guide says that a strip joins the Toolbelt. Use the installed commands output when choosing an exact subcommand.

Combat and notification commands

Command	Purpose
/toolbox combat	Toggle combat statistics; help lists detailed forms for statistics, detail views, alerts, reset, and movement.
/toolbox stats <text>	Search character-stat names that can be added to the combat HUD.
/toolbox notify	List notification states or change a source, route, sound, window form, HUD, or history.
/toolbox motd	off controls its standalone change window.
/toolbox sounds	Report alert sound files; a number from 0–100 sets volume and test plays samples.
/toolbox events	Report world events happening now and next, plus Cabalist Stronghold status; requires Lua API 35.

Menu and location commands

Command	Purpose
/toolbox menu	off, vertical|horizontal, size, shade, color gold|red|green|blue|white|text, combat hiding, and position. launcher is an alias.
/toolbox location	off, facing, scene fishable-water types, overlay controls, and position. Its background shade is set under Map & location.

Commands introduced in 1.8.0

Command	Purpose	Availability
/toolbox overlay	Open or manage the current scene's named map overlays, including selection, appearance, places, and compass navigation.	Approved in the Community Addons catalog
/toolbox mark	Add the player's current position to the selected user overlay.	Approved in the Community Addons catalog
/toolbox death	Report, show, clear, or point the compass toward the last-death marker.	Approved in the Community Addons catalog
/toolbox perf [quiet] [seconds]	Measure frame hitches for a diagnostic interval. The optional quiet mode pauses Toolbox timers during the test.	Approved in the Community Addons catalog

Crafting planner commands introduced in 1.9.0

Command	Purpose
/toolbox plan [recipe]	Open the planner, optionally searching for a known recipe.
/toolbox plan hud	Open or close the Crafting Planner HUD.
build	Choose whether the HUD begins on the shopping list or build order.
off, close <seconds>, or shade <0-90>	Configure automatic view changes, completion closing, and background shade.

See Crafting planner for the workflow and settings.

Toolbox 1.10.0 removed the former /toolbox plan book commands because clients with Lua API 55 now supply recipe outputs directly.

Text and layout

/toolbox font <9-32> changes the text size used by every window and strip; with no number it reports the current size. /toolbox spacing <0-12> changes their extra line spacing and, without a value, displays the current measurement. Version 1.9.0 places both controls on the first settings page, General. The combat-statistics HUD follows them too, with its own Size expressed as a percentage of the General text size.

Most HUD commands accept move <x> <y>. Omitting coordinates typically reports or invokes the feature's move behavior; the installed help text should be followed when a command rejects an incomplete form.

See also

• Toolbox
• Toolbox Toolbelt and HUDs
• Toolbox tracking
• Toolbox combat statistics
• Toolbox notifications
• Toolbox menu and location