Skip to content

Features Layout Profiles

Tuck edited this page Jun 28, 2026 · 3 revisions

Layout Profiles

Save, list, get, delete, and restore window layout configurations. Layout profiles capture the position, size, and workspace of every open window so you can snap back to your preferred arrangement with one command.

List Profiles

deskbrid profiles list

Response:

{
  "type": "response",
  "status": "ok",
  "data": [
    {
      "name": "coding",
      "created": "2024-01-15T10:00:00Z",
      "windows": 3
    },
    {
      "name": "presentation",
      "created": "2024-01-14T15:30:00Z",
      "windows": 1
    }
  ]
}

Protocol:

{"type": "layout_profiles.list"}

Save Profile

deskbrid profiles save coding
deskbrid profiles save presentation --overwrite

Protocol:

{"type": "layout_profiles.save", "name": "coding", "overwrite": false}

Response:

{
  "type": "response",
  "status": "ok",
  "data": {
    "name": "coding",
    "windows_saved": 3
  }
}

Get Profile Details

deskbrid profiles get coding

Protocol:

{"type": "layout_profiles.get", "name": "coding"}

Response:

{
  "type": "response",
  "status": "ok",
  "data": {
    "name": "coding",
    "created": "2024-01-15T10:00:00Z",
    "monitors": [
      {
        "windows": [
          {
            "app_id": "code",
            "title": "main.rs - project",
            "x": 0,
            "y": 0,
            "width": 1280,
            "height": 1440
          }
        ]
      }
    ]
  }
}

Restore Profile

deskbrid profiles restore coding
deskbrid profiles restore presentation

Protocol:

{"type": "layout_profiles.restore", "name": "coding"}

Delete Profile

deskbrid profiles delete old-profile

Protocol:

{"type": "layout_profiles.delete", "name": "old-profile"}

Python Example

from deskbrid import Deskbrid

client = Deskbrid()

# Save current layout
client.save_layout_profile("work", overwrite=True)

# Later, restore it
client.restore_layout_profile("work")

Typical Workflow

  1. Arrange your windows the way you like
  2. deskbrid profiles save myprofile
  3. Later or on a different session: deskbrid profiles restore myprofile

Profiles include:

  • Window positions and sizes
  • Workspace assignments
  • Monitor layout

Use Cases

  • Development: Save your editor + terminal + browser layout
  • Streaming: Quick switch to presentation mode
  • Coding: Restore your 3-pane layout with terminals in specific positions

Missing Actions (to be documented)

layout_profiles.ave

  • Description: [To be documented]
  • Input: [To be documented]
  • Output: [To be documented]
  • Example: [To be documented]

layout_profiles.layout_profile_delete

  • Description: [To be documented]
  • Input: [To be documented]
  • Output: [To be documented]
  • Example: [To be documented]

layout_profiles.layout_profile_get

  • Description: [To be documented]
  • Input: [To be documented]
  • Output: [To be documented]
  • Example: [To be documented]

layout_profiles.layout_profile_restore

  • Description: [To be documented]
  • Input: [To be documented]
  • Output: [To be documented]
  • Example: [To be documented]

layout_profiles.list

  • Description: [To be documented]
  • Input: [To be documented]
  • Output: [To be documented]
  • Example: [To be documented]

Clone this wiki locally