Skip to content
On this page

Brick Desktop app

What is the Desktop app?

The Brick Desktop app is a native system-tray companion for the Brick CLI, similar to the Dropbox tray icon. It shows live sync status and lets you pause, resume, or quit syncing without opening a terminal.

INFO

This app is currently in active development.

How it works

The Desktop app doesn't run the sync engine itself — it's a thin client for the local control API that a running brick process exposes (see Local Status/Control API). Click the tray icon to open a popover showing:

  • Current sync state (idle, syncing, paused, or error)
  • The folder being synced
  • Any in-flight transfer
  • Upload/download counters and recent activity
  • Pause, Resume, and Quit Brick controls

If brick isn't running, the app simply shows a "not running" state rather than an error.

Installation

The Desktop app is available for macOS, Windows, and Linux. It requires Brick CLI to be installed separately, since it's a companion to the CLI's sync engine rather than a replacement for it.

Getting started

  1. Install and log in to Brick CLI.
  2. Install and launch the Desktop app — it appears as an icon in your system tray or menu bar.
  3. Click the icon to see live sync status, or use the tray menu to pause, resume, or quit syncing.

Last updated:

Released under the MIT License.