JoyPro2 Discord GitHub
Engine (CLI)

engine profile

Show:

16 commands of engine profile. Each with every option and every value it takes, what it does, which GUI buttons use it, and an example.

#engine profile summary

written
engine profile summary
For beginners

Prints three counts of the profile: relations, binds and modifiers. Use it for a quick look whether the right profile is open and how big it is. The GUI's Profile Summary (Start page and Advanced page) runs it, and Reload in the profile bar runs it first.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile summary
Advanced
  • No options. engine profile without an action is the same command.
  • Without --profile the engine opens the last profile it opened (see engine profile load) and counts that one.
  • Read-only: nothing is saved.
Technical internals
  • Output: always one text line, relations=<n>, binds=<n>, modifiers=<n>, on stdout (no JSON; --text and --out change nothing).
  • Exit code 0.
  • Related: engine profile games (what an export writes per game), engine profile validate (errors and warnings).

What it does Shows profile-focused counts and status.

Used by the GUI Profile bar: Reload · Start: Profile Summary · Advanced: Profile Summary

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile summary --text

#engine profile load

written
engine profile load <path.pr0file>
For beginners

Opens a .pr0file, applies the load corrections and prints the counts of relations, binds and modifiers. The GUI runs it for Open profile... and Open last profile in the profile bar. The engine remembers the file, so a later command without --profile works on it.

engine profile load "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
  • The path is required (profile load requires a .pr0file path.).
  • The load corrections run (global --load-corrections, default true); --correction-report <file> writes their report (.txt / .log as text, otherwise JSON).
  • Actions of a relation that have no aircraft ticked leave the relation and become its dismissed suggestions. When there are any, the profile file is saved at once as a history version of its own ("Remove actions with no aircraft ticked"), so one undo brings them back.
  • The path is stored as the last opened profile in engine.meta.json (Documents\JoyPro, or JOYPRO_DATA_DIR).
Technical internals

What it does Loads a .pr0file into memory so later commands act on it.

Used by the GUI Profile bar: Open last profile

Example

engine profile load 'C:\JoyPro\profiles\pilot_main.pr0file'

#engine profile save

written
engine profile save <path.pr0file>
For beginners

Writes the loaded profile to the given .pr0file. JoyPro saves every change by itself; Save Profile on the Relations and Binds pages (and Ctrl+S) still runs this to write the file at once. The GUI also uses it to save a copy under a new name.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile save "C:\Users\Pilot\Documents\JoyPro\My Sticks copy.pr0file"
Advanced
  • The target path is required (profile save requires a target .pr0file path.). A missing folder is created; an existing file is overwritten.
  • The save is a version in the target's profile history, like every save.
  • The target becomes the last opened profile (engine.meta.json).
Technical internals

What it does Saves current in-memory profile state to a .pr0file.

Used by the GUI Relations: Save Profile · Binds: Save Profile

Example

engine profile save 'C:\JoyPro\profiles\pilot_main.pr0file'

#engine profile new

written
engine profile new <path.pr0file>
For beginners

Creates an empty profile file: no relations, binds or modifiers. The GUI's New profile runs it with a new file (My profile.pr0file, My profile 2.pr0file, ...) in Documents\JoyPro2\profiles. Fill it afterwards with an import, for example engine dcs import.

engine profile new "C:\Users\Pilot\Documents\JoyPro\New Setup.pr0file"
Advanced
  • <path.pr0file> is required. Missing folders are created.
  • An existing file of that name is overwritten without asking. Its old content is not lost: it stays in the profile history of that path as a version (engine profile history, restore brings it back), unless the history is switched off.
  • JoyPro's own settings (the meta settings) are kept; the new file becomes the last opened profile, so the next command without --profile opens it.
  • --profile is not changed by this command (it is only read first).
Technical internals

What it does Creates an empty profile and saves it to the given .pr0file (overwrites an existing file).

Example

engine profile new 'C:\JoyPro\profiles\new_setup.pr0file'

#engine profile save-last

written
engine profile save-last
For beginners

Writes the loaded profile into JoyPro's own last-profile file. The GUI's Save as last profile in the profile bar's Options panel runs it. Most people never need it: JoyPro saves your profile file by itself.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile save-last
Advanced
  • No options. The file is last.pr0file in Documents\JoyPro (or JOYPRO_DATA_DIR), together with engine.meta.json.
  • last.pr0file has no profile history.
  • A command without --profile opens the last opened profile; only when that file does not exist it opens last.pr0file.
  • dcs import, il2 import and starcitizen import do the same with --save-last.
Technical internals

What it does Saves to JoyPro's last-used profile path.

Used by the GUI Profile bar: Save as last profile

Example

engine profile save-last

#engine profile validate

written
engine profile validate [--fail-on-warnings true|false]
For beginners

Checks your profile for problems: one button that does two things, two actions of one aircraft in one relation, unknown commands, modifier problems. It changes nothing. The Check's Check now runs it.

engine profile validate --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced
  • Errors: one input in two relations with an action of the same aircraft on (one button does two things), two actions of one aircraft on in one relation, unknown commands.
  • Warnings: modifier problems and other findings that do not count as errors.
  • --fail-on-warnings true (default false) makes warnings fail the exit code too (for scripts).
  • The GUI's Check builds its cards from this and the detailed reports of engine relations conflicts, engine relations duplicates and engine export-marks list.
Technical internals
  • Output: JSON with the errors and warnings, or text with --text.
  • Exit code 1 with profile validation failed: errors = <n>. when there are errors, or with profile validation failed: warnings = <n> (--fail-on-warnings true).; else 0.
  • Read-only; another argument fails with Unknown profile validate argument(s).

What it does Validates the loaded profile and reports both warnings and errors across relation items, binds, modifiers, and active-node states.

OptionValuesMeaning
--fail-on-warningstrue falseFor profile validate: treat warnings as failure (non-zero exit) in addition to errors.
Every value as a command line
engine profile validate --fail-on-warnings true
engine profile validate --fail-on-warnings false

Used by the GUI Check: Show all again · Check: Apply the ticked ones · Relations: Review them · Relations: ReturnToCheckCommand · Check: Check now · Export: Validate Profile

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile validate --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile validate --fail-on-warnings true --text
How the options interact
  • Validation always reports both warnings and errors.
  • Default exit behavior fails only when errors exist.
  • Set --fail-on-warnings true for CI or strict runs where warnings should also fail the command.

#engine profile head-tracking

written
engine profile head-tracking [yes|no|clear]

The Setup wizard's head-tracking / VR answer kept in the profile: with yes Auto Group and the suggestions make no look-around relations in the sims that support head tracking; the recenter stays

For beginners

Keeps your answer to the question "Do you use head tracking or VR?" in the profile. yes: you look around by turning your head, so the setup puts no look buttons on your HOTAS in the flight sims, only a button to recenter the view. no: looking around goes on a hat of your stick or throttle, with a high priority. clear removes the answer. Without a value it only shows the answer. Settings > Looking around runs it.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile head-tracking yes --text
Advanced
  • No value: read-only, shows yes, no or not asked.
  • yes (also true, on, 1): in the sims that support head tracking or VR, Auto Group makes no look-around relation (snap views, look axes) and the suggestions propose no look command. The recenter, zoom, padlock and the camera views stay.
  • no (also false, off, 0): the setup places looking around on a hat, right after the fight essentials and the trim.
  • clear: the answer is removed; the setup then plans like no until the question is answered again.
  • Look relations the profile already has stay as they are.
  • engine setup plan without --head-tracking uses this answer; engine setup apply writes the plan's answer into the profile.
Technical internals
  • Output: JSON {"HeadTracking": "yes"|"no"|""}, or with --text the line Head Tracking: yes, no or not asked.
  • With a value the profile is saved (one profile version, so it can be undone).
  • Exit code 1 with engine profile head-tracking takes yes, no or clear. for another value, or with the usage line for more than one value; else 0.
  • Related: engine setup plan, engine setup apply, engine relations auto-group, engine relations suggest.

What it does Shows or sets the answer to the Setup wizard's question 'Do you use head tracking or VR?' that the profile keeps. yes: you look around with head tracking, a face tracking webcam, an eye tracker or VR, so the setup, Auto Group and the suggestions put no look-around buttons on the HOTAS in the sims that support head tracking; only the recenter stays (zoom, padlock and the camera views too). no: looking around goes on a hat of the stick or throttle, with a high priority. clear removes the answer (not asked: planned like no). Without a value it only shows the answer.

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile head-tracking --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile head-tracking yes --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile head-tracking clear
How the options interact
  • Without a value: read-only, prints the answer (yes, no, or not asked).
  • yes (also true, on, 1): no look-around buttons on the HOTAS in the sims that support head tracking, only the recenter; Auto Group makes no look-around relations there and the suggestions propose no look commands.
  • no (also false, off, 0): looking around goes on a hat with a high priority (right after the fight essentials and the trim).
  • clear: removes the answer; the setup then plans like no until the question is answered.
  • With a value the profile is saved (one profile version). engine setup plan without --head-tracking uses this answer, engine setup apply writes the plan's answer here, and Settings > Looking around runs this command.
  • Look relations the profile already has stay as they are.

#engine profile game-state

written
engine profile game-state --game <id> [--path <config>]

Has this profile imported from or exported to the game, and does the game have binds of its own: the GUI asks 'Import first?' before the first export

For beginners

Tells whether your profile has imported from or exported to a game, and whether the game has binds of its own. The GUI uses it to ask "Import first?" before the first export into a game that has its own binds.

engine profile game-state --game DCS --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" --text
Advanced

--game <id> is required; --path <config> checks another config folder than the detected one. Read-only.

Technical internals

What it does Has this profile imported from or exported to the game, and does the game have binds of its own: the GUI asks 'Import first?' before the first export.

OptionValuesMeaning
--game<id>Game filter value. Example: DCS or IL2Game.
--path<config>Optional explicit path override. Use when you prefer option form over positional path.

Used by the GUI Export: Export ticked games · Export: Export now

Example

engine profile game-state --game <id> --text

#engine profile auto-added

written
engine profile auto-added [--apply [--skip "key;key"] | --keep]

Aircraft an earlier load correction switched on that you never bound, found in the profile history; --apply takes them out, --keep stops asking; one undo step

For beginners

Up to JoyPro 2.6.1 the repair that runs when the command lists change (Refresh DB, an update with new lists) could switch on aircraft in your relations that you never bound. This finds such a step in the profile's history and lists the aircraft it switched on that are still on, per relation what goes and what stays. --apply takes them out again, --keep keeps them and stops asking. The GUI asks right after a profile opens.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile auto-added --text
engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile auto-added --apply --skip "3fa1c2d9e0b7" --text
Advanced
  • Without --apply or --keep read-only.
  • A step counts when it was made by a change (not an undo, a restore, an import, a take-over or a builder such as Auto Group), its version has another DB fingerprint than the version it was made on, and aircraft went from "not in the action" to "on" in existing actions of at least 3 relations. Relations the step's label names (your own edit) are left out; so is an aircraft an import brought in since. A step right after a Before import from checkpoint, or one that made 3 or more new relations or binds, counts as an import or builder too.
  • Default and the other input layers of DCS are no aircraft: listed with NonAircraft, not in Aircraft and RelationCount. --apply takes them out like the rest. The GUI shows no notice when there is nothing else.
  • --apply puts each aircraft back to "not in the action", except the keys given with --skip; --keep changes no relation. Both are one profile version (one undo step) and mark the steps as looked at, so they are not offered again.
Technical internals
  • Output: JSON Found, Aircraft, NonAircraft, RelationCount, Steps (Version, Utc, Local, Label, Aircraft, NonAircraft, Relations), Relations (Relation, Remove, Keeps, KeepsAircraft, NonAircraft), Entries (Key, Version, Relation, Game, Id, Plane, Title, NonAircraft, Skipped), after --apply/--keep also Applied, Kept, Removed, RemovedNonAircraft, KeptAircraft, Message; --text for a table.
  • History labels: Took out aircraft JoyPro added: n aircraft in m relations, Kept the aircraft JoyPro added.
  • Exit code 0. Related: engine profile history, engine profile load.

What it does The repair for profiles an earlier load correction filled up (2.6.1 and older switched on, after Refresh DB or an update, every aircraft of an action's command id you had never bound): reads the profile history for such a step and lists the aircraft it switched on that are still on, per relation what goes (Remove) and what stays (Keeps). --apply takes them out (--skip keeps the listed keys), --keep stops asking; either is one profile version (one undo step). Without either nothing changes.

OptionValuesMeaning
--applyswitch (no value)Takes the listed aircraft out of their actions again (back to how the node was before the correction).
--skipswitch (no value)Keys (from the listing, 'Key') of aircraft to leave switched on, separated by ;. Example: --skip '3fa1c2d9e0b7;90ab12cd34ef'.
--keepswitch (no value)Keeps every listed aircraft and stops asking (the profile remembers the answer).

Used by the GUI Profile bar: Take them out · Profile bar: Keep these aircraft

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile auto-added --text
engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile auto-added --apply --skip '3fa1c2d9e0b7' --text

#engine profile games

written
engine profile games

Games and DCS aircraft the profile has relations for, with how many are bound: what each export writes

For beginners

Lists the games, and for DCS the aircraft, that the profile has relations for, with how many of them are bound. That is what an export to each game would write. The Export page builds its cards from it (its Refresh runs it), and so does the export from a Start page card.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile games --text
Advanced
  • No options. Read-only.
  • A relation counts once per game; it counts as bound when its bind has a button or an axis (the same test the exporters use).
  • DCS: per aircraft that is ticked in the relation's DCS actions; an action with no aircraft ticked counts under Default.
  • Per game also whether it is installed, its installation folder and whether you hid it (engine games install disable). DCS comes first, then the games by name.
Technical internals

What it does Games and DCS aircraft the profile has relations for, with how many are bound: what each export writes.

Used by the GUI Start: Export · Export: Refresh · Settings: Detect again · Settings: Use detected

Example

engine profile games --text

#engine profile merge

written
engine profile merge <left.pr0file> <right.pr0file> [<more.pr0file> ...] [--mode left|right|ask] [--overwrite-mode left|right|ask] [--save <path.pr0file>] [--save-profile <path.pr0file>]

The files are merged left to right; a relation both have: right = the later file wins (default), left = the first file keeps it, ask = the console asks; --overwrite-mode is another name for --mode, --save-profile for --save

For beginners

Combines two or more profile files into one. Relations only one file has are added; where both have a relation of the same name, the mode decides which one wins. The GUI's Merge (profile bar, Options panel) and Merge Profile on the Relations and Binds pages run it with your profile as the left file; they ask first and keep a copy of your profile.

engine profile merge "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" "C:\Users\Pilot\Documents\JoyPro\Friend.pr0file" --mode left --save "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file"
Advanced
--mode When both files have a relation of the same name and it differs
right (default; also r, overwrite, keep-right) the later file's relation and bind win
left (also l, keep-left) the first file's relation stays
ask (also a, prompt) the console asks per conflict; refused without an interactive console
  • Files are merged from left to right: the first file is the base, every further file is merged into it.
  • Relations are matched by name (case does not matter); identical ones are skipped.
  • Also merged, with the same rule: device aliases and pictures, device IDs, aircraft aliases, modifier renames, the DCS force feedback settings, the force feedback settings of the games, the layout export and the last selected DCS folder.
  • --save <file> (also --save-profile) writes the result; --overwrite-mode is another name for --mode.
  • With the global --profile the result is also auto-saved into that profile file. The source files are only read.
Technical internals
  • Output: text lines Merged profiles: <n>, Conflict mode: <mode>, Conflicts: <n>, Resolved Left: <n>, Resolved Right: <n>, the counts, and Saved merged profile: <path>.
  • Exit code 0; 1 with fewer than two files (profile merge requires at least two source files ...), a missing file (profile merge source does not exist: <path>), an unknown mode (... Use left|right|ask.), both --mode and --overwrite-mode, or an unknown option.
  • Related: engine profile history (undo), engine profile summary.

What it does Merges two or more .pr0file files from left to right into the loaded profile: relations only one file has are added; for a relation of the same name that differs, --mode decides (right = the later file wins, the default; left = the first file keeps it; ask = the console asks per conflict). Device aliases and pictures, aircraft aliases, modifier renames and the force feedback settings follow the same rule. The source files are only read; --save writes the result.

OptionValuesMeaning
--modeleft right askWhat wins when two files have a relation of the same name that differs: right (default; also r, overwrite, keep-right) = the later file, left (also l, keep-left) = the first file, ask (also a, prompt) = the console asks per conflict (refused without an interactive console).
--overwrite-modeleft right askAnother name for --mode (left|right|ask); give only one of them.
--save<path.pr0file>Write the merged profile to this .pr0file (the source files are only read).
--save-profile<path.pr0file>Another name for --save.
Every value as a command line
engine profile merge --mode left
engine profile merge --mode right
engine profile merge --mode ask
engine profile merge --overwrite-mode left
engine profile merge --overwrite-mode right
engine profile merge --overwrite-mode ask

Used by the GUI Profile bar: Merge · Relations: Merge Profile · Binds: Merge Profile

Example

engine profile merge 'C:\JoyPro\profiles\pilot_main.pr0file' 'C:\JoyPro\profiles\friend.pr0file' --mode left --save 'C:\JoyPro\profiles\merged.pr0file' --text

#engine profile history

written
engine profile history [list]

The versions of --profile, newest first: every save is one, kept in <data>\ProfileHistory; undo/redo state

For beginners

Lists the versions of your profile, newest first. Every save of the profile is one version, and so is the state before each import or export. The GUI's History in the top bar shows the same list.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile history --text
Advanced
  • engine profile history and engine profile history list are the same. --profile is required.
  • Per version: number, local time, kind (change, open, external, checkpoint, restore, undo, redo), its name and what it changed in short, [kept] for a version the clean-up never removes and [current] for the version the profile is at.
  • The list also tells whether undo and redo are possible and what they would take back or bring back.
  • Read-only. The other actions: engine profile history show (and diff), engine profile history restore (and undo, redo), engine profile history keep (and checkpoint), engine profile history prune (and usage).
Technical internals
  • Output: JSON (Profile, Folder, Cursor, CanUndo, UndoLabel, CanRedo, RedoLabel, Bytes, Kept, Versions with Id, Utc, Local, Kind, Label, Summary, Keep, Size, Parent, From, Current), or text with --text (History of <file>: <n> version(s), <n> kept, <size>, one line per version).
  • Exit code 1 with engine profile history list needs --profile <file>. or Unknown profile history list argument(s): ....
  • The history lives in %LOCALAPPDATA%\JoyPro2\ProfileHistory\<profile id>\ (history.json and one compressed copy per distinct content). JOYPRO_PROFILE_HISTORY=off switches the recording off. See profile-history.

What it does The versions of --profile, newest first: every save is one, kept in <data>\ProfileHistory, with the undo / redo state.

Example

engine profile history --text

#engine profile history show

written
engine profile history show <id> | diff <id> [<id>|current]

What a version changed / the changes between two versions

For beginners

Shows what one version of the profile changed, or with diff the changes between two versions: relations created or renamed, binds moved, modifiers, tuning and settings. The History panel's Details and Compare show the same.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile history show 12 --text
Advanced
  • show <id>: the changes of that version against the version it was made on.
  • diff <id> [<id>|current]: the changes from the first version to the second; without the second, to the version the profile is at now.
  • A version is its number (12 or #12), latest (the newest) or current (where the profile is now). The numbers come from engine profile history.
  • A version that was changed outside JoyPro (another program, an older JoyPro) has no details; the output says so.
  • Read-only. --profile is required.
Technical internals
  • Output: JSON (From, To, Available, Summary, Changes), or text with --text: for show the line Version <id> | <time> | <kind> (with | kept) and its description, for diff Changes from version <a> to <b>:, then one line per change, or no change in relations, binds or settings.
  • Exit code 1 with the usage line (engine profile history show <version id>, ... diff <version id> [<version id>|current]), Version <id> is not in the history. or Unknown version: <id>.
  • Related: engine profile history restore; profile-history.

What it does What a version changed (show), or the changes between two versions or a version and the current profile (diff).

Example

engine profile history show <id> --text

#engine profile history restore

written
engine profile history restore <id> | undo | redo

Writes a version back into the profile; that is a version too, so it can be undone

For beginners

Puts an older version of the profile back, or takes the last change back (undo) and brings it back again (redo). The top bar's Undo, Redo and the History panel's Roll back to here do the same (a restore takes back every change after that version in one step).

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile history restore 12 --text
Advanced
  • restore <id>: writes that version into the profile file. The restore is a version of its own, so undo returns to the state before it. It clears the redo list. A version is its number, latest or current.
  • undo: writes back the version the last change was made on; the undone version can come back with redo.
  • redo: writes back the newest undone version. Any new change clears what could be redone.
  • Safety: before it writes, a profile file that was changed outside JoyPro is kept as a version of its own, so nothing is lost. A checkpoint before an export does not count as a change: undo after an export takes back your last edit, not the export.
  • Only the profile file changes; the games keep their binds until the next export. --profile is required.
Technical internals
  • Output: JSON (Action, Changed, Message, Version), or the message with --text: Rolled back to the version of <time>., Undone: <description>., Redone: <description>., The profile is already at this version., Nothing to undo., Nothing to redo. or This profile has no history yet. (exit code 0, Changed false for the last four).
  • Exit code 1 with engine profile history restore <version id> (a version of 'engine profile history list'). when the id is missing or not in the history, or ... needs --profile <file>.
  • The engine does not save its loaded profile afterwards, so the restored file stays as written. Related: engine profile history, engine support unpack; profile-history.

What it does Writes a version back into the profile (restore), or steps back / forward (undo / redo); that is a version too, so it can be undone.

Example

engine profile history restore <id> --text

#engine profile history keep

written
engine profile history keep <id> [on|off] | checkpoint [--label <text>]

A kept version is never cleaned up; a checkpoint keeps the profile as it is now

For beginners

Marks a version of the profile as kept, so the automatic clean-up never removes it, or keeps the profile as it is now as a named version (checkpoint). Use a checkpoint before a big change you may want to go back from.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile history checkpoint --label "Before new throttle" --text
Advanced
  • keep <id> [on|off]: on (or nothing) keeps the version; off (or false) lets the clean-up remove it again. Any other second word counts as on. A version is its number, latest or current.
  • checkpoint [--label <text>]: the profile file as it is now becomes a version of kind checkpoint named by the label (default Checkpoint). A checkpoint does not move the undo position. When the history is switched off, nothing is recorded and the output says so.
  • Only the history changes, never the profile. --profile is required.
Technical internals
  • Output: JSON (Action, Changed, Message, Version), or the message with --text: Version <id> is kept (never cleaned up)., Version <id> may be cleaned up again., Kept as version <id>. or The profile history is switched off.
  • Exit code 1 with engine profile history keep <version id> [on|off], Version <id> is not in the history., The profile file does not exist: <file> (checkpoint) or ... needs --profile <file>.
  • Related: engine profile history prune, engine profile history; profile-history.

What it does Keeps a version for good (on) or not (off), or keeps the profile as it is now as a checkpoint; kept versions are never cleaned up.

OptionValuesMeaning
--label<text>

Example

engine profile history keep <id> --text

#engine profile history prune

written
engine profile history prune [--all] [--dry-run] | usage [--all]

Clean-up: all of 24 h, hourly 7 days, daily 60 days, weekly after; 200 MB per profile, 1 GB in total

For beginners

Cleans up the profile history now, or shows how much room it takes (usage). JoyPro also cleans up by itself every 6 hours, so you rarely need it; the History panel's Clean up does the same for all profiles.

engine --profile "C:\Users\Pilot\Documents\JoyPro\My Sticks.pr0file" profile history prune --dry-run --text
Advanced
  • prune: the history of --profile. It keeps every version of the last 24 hours, the newest of every hour up to 7 days, of every day up to 60 days, of every week after that; then the oldest versions go until the history is under 200 MB.
  • prune --all: every profile's history (no --profile needed), then the oldest versions of all profiles go until all histories together are under 1 GB.
  • Never removed: kept versions (engine profile history keep), the newest version, the version the profile is at and what can still be redone. Copies no version uses any more are deleted.
  • --dry-run lists what would go and removes nothing; with --all it counts the 1 GB step too.
  • usage [--all]: versions, kept versions and size of this profile's history (or of all); read-only.
Technical internals
  • Output: JSON (Action, Changed, Message, Removed, BytesBefore, BytesAfter, VersionsLeft; for usage Profiles, Versions, Kept, Bytes), or text with --text: Removed <n> version(s): <size> -> <size>, <n> version(s) left. (Would remove on a dry run) with one line per removed version; Profile history: <n> version(s), <n> kept, <size> in <folder>.
  • Exit code 0; 1 with engine profile history prune needs --profile <file>. when neither --profile nor --all is given.
  • Folder: %LOCALAPPDATA%\JoyPro2\ProfileHistory. Related: engine profile history; profile-history.

What it does The clean-up: everything of 24 hours, one version per hour for 7 days, per day for 60 days, per week after; at most 200 MB per profile and, with --all, 1 GB for all profiles (the oldest versions of all profiles go first). --dry-run counts every step, the global cap included; usage shows the sizes.

OptionValuesMeaning
--allswitch (no value)Apply operation to all matches (or select all relations/devices where supported).
--dry-runswitch (no value)Report what the command would do; nothing is written or changed.

Example

engine --profile 'C:\JoyPro\profiles\pilot_main.pr0file' profile history prune --dry-run --text
engine profile history prune --all --dry-run --text