AppleScript¶

DesktopRenamer's scripting dictionary is available to Script Editor after the app is installed. Commands return immediately for operations that require Mission Control or Accessibility timing.

Space commands¶

tell application "DesktopRenamer"
    get api version
    get current space name
    get current space id
    get all spaces
    rename current space to "Writing"
    switch to space "SPACE-ID"
    rename space "SPACE-ID" to "Research"
    rearrange space "SPACE-ID" direction "up"
end tell

get all spaces returns one line per space with fields separated by ~:

UUID~Name~DisplayName~Number~IsFullscreen~AppPath

get all spaces is sorted by display and space number. Names and paths may be empty. Space identifiers are not guaranteed to survive display changes or Mission Control recreation.

The direction parameter for rearrange space must be up or down.

Command reference¶

Command	Parameters	Return / timing
`get api version`	—	Returns the API contract version immediately.
`get current space name`	—	Returns a string immediately.
`get current space id`	—	Returns current ManagedSpaceID values, comma-separated for multiple displays.
`get all spaces`	—	Returns the multiline space record described above.
`rename current space`	Text	Asynchronous; returns no value.
`rename space`	Space ID, `to` text	Asynchronous; returns no value.
`switch to space`	Space ID	Asynchronous; returns no value.
`rearrange space`	Space ID, `direction`	Asynchronous; moves one position.

Invalid rearrangement directions set the script error to Direction must be up or down. The API-disabled error is API Disabled.

Label and launcher commands¶

tell application "DesktopRenamer"
    toggle menubar
    toggle launcher
    toggle labels
    toggle active label
    toggle preview label
    toggle desktop visibility
    reload space labels
end tell

API-disabled behavior¶

When the API is disabled, commands return API Disabled where a result is defined, or do nothing for asynchronous commands. Automation clients should treat this as a recoverable configuration state.