Skip to content

Workspaces

A workspace is a self-contained folder that holds everything Muxit needs to run your lab: device connectors, automation scripts, dashboards, drivers, and configuration.

What's Inside a Workspace

my-workspace/
  config/         Server settings (server.json, ai-memory.json)
  connectors/     Device configurations (.js files)
  scripts/        Automation scripts (.js files)
  dashboards/     Dashboard layouts (.dashboard.json)
  agents/         AI agent configs (.agent.json)
  drivers/
    community/    Free extension drivers (.dll)
    premium/      Licensed drivers (.dll)
  data/           Sandboxed file storage

First-Run Setup

When you start Muxit for the first time, you'll see a setup screen with two options:

  1. Create New Workspace --- Pick a location and name for your workspace. Muxit creates the folder structure automatically.
  2. Open Existing Workspace --- Point Muxit at an existing workspace directory.

After setup, Muxit restarts and opens your workspace.

Creating a New Workspace

From the File menu, select New Workspace.... This opens a dialog where you can specify:

  • Location --- The filesystem path where the workspace will be created (e.g., /home/user/my-lab or C:\Users\me\Documents\my-lab).
  • Name (optional) --- A friendly name for the workspace. Defaults to the folder name.

Muxit creates the standard directory structure and a minimal server.json configuration file.

Opening an Existing Workspace

From the File menu, select Open Workspace.... The dialog shows:

  • A list of all previously opened workspaces, sorted by last-opened time
  • The currently active workspace (highlighted with a "current" badge)
  • An option to create a new workspace

Click any workspace in the list to switch to it. Muxit will restart automatically with the selected workspace.

Switching Workspaces

When you switch workspaces, the server performs a graceful restart:

  1. All running scripts and agents are stopped
  2. All connector connections are closed
  3. The server shuts down
  4. The launcher restarts the server with the new workspace path

This process takes a few seconds. The browser will automatically reconnect when the server is back up.

Managing the Workspace List

  • Workspaces are automatically added to the list when you create or open them
  • Click the X button on any workspace entry to remove it from the list (this does not delete the workspace folder)
  • Missing workspaces (deleted folders) are shown as dimmed with a "missing" badge

Workspace Catalog

Muxit stores the list of known workspaces in a catalog file outside any workspace:

  • Linux/macOS: ~/.muxit/workspaces.json
  • Windows: %LOCALAPPDATA%\Muxit\workspaces.json

This file persists across workspace switches and server restarts.

Command-Line Usage

You can also specify a workspace directly when starting the server:

bash
node start.js server --workspace=/path/to/my-workspace

Or with the compiled binary:

bash
muxit --workspace=/path/to/my-workspace

The specified workspace is automatically registered in the catalog.

Muxit — Hardware Orchestration Platform