Developer App

Tour the Developer App interface — canvas controls, tools, publishing, and preferences

Developer App

The TelemetryOS Developer App is a desktop application for building and testing TelemetryOS applications locally. It provides a simulated device runtime with live preview, canvas controls for testing different screen sizes, and tools for publishing directly to the platform.

Installation

In Studio, open the Applications page and click Get Developer App.

Download the installer for your operating system (macOS, Windows, or Linux) and run it.

info The tos CLI is bundled with the Developer App. Once installed, commands like tos init, tos dev, and tos publish are available in your terminal.

Welcome Screen

When you launch the Developer App with no project open, you see the Welcome Screen.

New Project opens a dialog where you name your project, choose a template, and optionally include Claude Code skills for AI-assisted development.

Two templates are available:

  • Render + Settings — the standard template with a display view and a configuration sidebar
  • Render + Settings + Web — adds a browser-accessible web mount point for staff or public interfaces

Open Project lets you browse to an existing project directory. Recent Projects lists projects you have previously opened for quick access.

You can also create and open projects from the terminal:

tos init my-app
cd my-app
tos dev

The Project Window

When a project opens, the Developer App starts its dev server and displays the project in a simulated TelemetryOS environment.

The window has three main areas:

  • Canvas (center) — displays your render mount point in a resizable preview that simulates a device screen
  • Settings sidebar (right) — displays your settings mount point, mirroring the configuration panel that administrators see in Studio
  • Toolbar (bottom) — controls for switching aspect ratios and backgrounds

Storage writes from the settings view propagate to the render view in real time, just as they would on a deployed device. The tab bar at the top switches between the Render and Settings tab and the Web Mount Point tab (if your project has one).

Canvas Controls

The bottom toolbar lets you test how your application looks on different screen sizes and against different backgrounds.

Aspect ratio presets (left group) simulate common display form factors:

PresetUse case
5:1 ChironUltra-wide LED strips, ticker boards
3:1 LandscapeWide banner displays
16:9 LandscapeStandard widescreen monitors and TVs
1:1 SquareSquare panel displays
1:1 Small SquareSmaller square panels (renders at 33% scale)
9:16 PortraitVertical signage, portrait monitors
1:3 PortraitTall narrow displays
1:5 SkyscraperUltra-tall displays, digital totems

Cycle through presets with Cmd+] / Cmd+[ (Ctrl on Windows/Linux).

Background presets (right group) change the area behind the canvas. These help you check how your content looks in different contexts, since the actual background behind your application on a device depends on the playlist layout:

  • Black / White — test contrast and edge visibility
  • Checkerboard — check for unintended transparency
  • Gradient / Sunset — simulate colorful surroundings
  • Image — use a custom background image for realistic testing

Cycle through backgrounds with Cmd+Shift+] / Cmd+Shift+[.

Web Mount Point Tab

If your project defines a web mount point in telemetry.config.json, a Web Mount Point tab appears in the tab bar. This tab provides a browser-like view with an address bar for testing your web interface.

The address bar supports:

  • Back / Forward buttons — navigate through page history
  • Path input — type a path and press Enter to navigate directly (paths are automatically prefixed with /)

Switch between tabs with Cmd+1 / Cmd+2 or Ctrl+Tab.

Tools

The Tools menu contains development utilities. Most of these are only available when a project is open.

Delete Stub Data

During local development, the Developer App stores mock SDK data — storage values, media content, account information — as files in your project's .telemetryos/ directory. This data persists across dev server restarts so your application state survives while you work.

Delete Stub Data (Cmd+D) clears all of this persisted mock data, resetting your application to a clean first-run state. Use this when:

  • Stale test data is causing unexpected behavior
  • You want to test your application's first-run or empty-state experience
  • You have changed your storage schema and want to start fresh

warning Deleting stub data removes all locally persisted mock storage, media, and account data. Your application will behave as if running for the first time.

Screenshots and Thumbnails

The Tools menu offers four screenshot options:

  • Screenshot Render Mount Point — captures the render canvas at its current aspect ratio
  • Screenshot Render Mount Point – All Aspect Ratios — captures one screenshot per preset (8 images total), useful for testing or marketing materials
  • Screenshot Settings Mount Point — captures the settings sidebar
  • Screenshot Web Mount Point — captures the web tab

Screenshots are saved as PNG files in your project directory.

Capture App Thumbnail is different from the screenshot options — it saves a 512×512 image used as your application's icon in Studio. Run this before publishing so your app has a recognizable thumbnail in the application registry.

Restart Dev Server

Restart Dev Server (Cmd+Alt+R) stops and restarts the underlying dev server process. Use this when hot module replacement stops working or when you need to pick up configuration changes that require a full server restart.

External Tools

  • Reveal in Finder / Explorer (Cmd+F) — opens your project directory in the file manager
  • Open in Editor (Cmd+E) — opens the project in your preferred code editor (configurable in Preferences)
  • Open Project in Terminal (Cmd+T) — opens a terminal session in the project directory

Publishing from the App

The Developer App provides a visual workflow for inspecting, versioning, and publishing your application.

App Info

App Info (Cmd+I) displays a read-only summary of your project's telemetry.config.json: name, version, logo, thumbnail, configured mount points, background workers, and containers. Review this before publishing to verify your configuration is correct.

Version, Archive, and Publish

TelemetryOS applications use calendar versioning (CalVer) in the format YYYY.MM.PATCH (for example, 2026.04.1).

  • Bump Version (Cmd+Shift+V) — increments the patch number
  • Archive (Cmd+Shift+A) — bumps the version and creates a .tar.gz file for manual upload or CI pipelines
  • Publish (Cmd+Shift+P) — bumps the version, archives, uploads to TelemetryOS, and monitors the server-side build

Both Archive and Publish have "without Version Bump" variants (hold Alt) when you want to re-export or re-publish the current version.

info You must authenticate before publishing. Run tos auth in your terminal — see Local Development for details.

Preferences

Open Preferences with Cmd+, to configure:

  • Appearance — light, dark, or system color scheme
  • Default editor — which code editor "Open in Editor" launches
  • Reopen projects on launch — restore your previous session automatically

Keyboard Shortcuts

ActionmacOSWindows / Linux
New ProjectCmd+NCtrl+N
Open ProjectCmd+OCtrl+O
App InfoCmd+ICtrl+I
Bump VersionCmd+Shift+VCtrl+Shift+V
ArchiveCmd+Shift+ACtrl+Shift+A
PublishCmd+Shift+PCtrl+Shift+P
Next Aspect RatioCmd+]Ctrl+]
Previous Aspect RatioCmd+[Ctrl+[
Next BackgroundCmd+Shift+]Ctrl+Shift+]
Previous BackgroundCmd+Shift+[Ctrl+Shift+[
Tab 1 (Render and Settings)Cmd+1Ctrl+1
Tab 2 (Web Mount Point)Cmd+2Ctrl+2
Next TabCtrl+TabCtrl+Tab
Previous TabCtrl+Shift+TabCtrl+Shift+Tab
Restart Dev ServerCmd+Alt+RCtrl+Alt+R
Delete Stub DataCmd+DCtrl+D
Reveal in Finder / ExplorerCmd+FCtrl+F
Open in EditorCmd+ECtrl+E
Open in TerminalCmd+TCtrl+T
PreferencesCmd+,Ctrl+,

Next Steps


What’s Next