Skip to content

Installation

Get Muxit running on your machine in under a minute.

Open PowerShell and run:

powershell
irm https://raw.githubusercontent.com/muxit-io/muxit/main/install.ps1 | iex

This downloads the latest release, extracts it to %LOCALAPPDATA%\muxit, and adds it to your PATH. No prerequisites required — the binary is fully self-contained.

Manual Download

If you prefer to install manually:

  1. Go to the GitHub Releases page
  2. Download muxit-win-x64-v<version>.zip (the file name includes the release version)
  3. Extract the zip to a folder of your choice (e.g. C:\muxit)
  4. Run muxit.exe from the extracted folder

System Requirements

RequirementDetails
OSWindows 10 or later (x64)
RuntimeNone — self-contained binary, no .NET or Node.js needed
Disk space~150 MB
NetworkRequired for AI features and license activation; optional otherwise

First Run

After installing, start Muxit:

powershell
muxit

This starts the server and opens your default browser to http://localhost:8765.

On first run, you'll see the Workspace Setup screen. Create a new workspace or open an existing one to get started. See Workspaces for details.

Other start modes:

powershell
muxit                       # Start without opening browser
muxit --no-tray             # Start without system tray icon
muxit --port=9000           # Use a custom port

Verify It Works

Once the server is running and the browser opens:

  1. Check the Hardware panel — Click the plug icon in the left Activity Bar. You should see test-device listed with live properties (temperature, label, count, etc.)
  2. Open a demo dashboard — In the Explorer sidebar, expand dashboards/ and click demo.dashboard.json. You should see live gauges and widgets
  3. Run a script — In the Explorer sidebar, expand scripts/ and click hello.js. Click the Run button in the editor toolbar. Check the Output panel at the bottom for log messages

If you see the test device with updating values, Muxit is working correctly.


What's Included

Muxit ships as a single self-contained package — no hardware needed to get started:

CategoryWhat's Included
MuxitServerSelf-contained .NET 9.0 binary (no runtime install needed)
Built-in driversTestDevice, Webcam, ONVIF (IP camera), FileAccess, MqttBridge
Example connectorstest-device, webcam, gui, store, and more in workspace/connectors/
Example scriptshello.js, demo.js, count_to_ten.js, stream-demo.js, and more
Example dashboardsdemo, test-device, robot, gcode, and more
Example agentstemperature-monitor, pick-and-place
DocumentationBuilt-in at /docs/ in the web UI

The TestDevice is a simulated device that exercises every data type (strings, numbers, booleans, arrays, objects). It's always available and doesn't count against your connector limit — making it the perfect learning tool.


Updating

Re-run the installer — it detects the existing installation and updates in place:

powershell
irm https://raw.githubusercontent.com/muxit-io/muxit/main/install.ps1 | iex

Your workspace files (connectors, scripts, dashboards, agents, config) are preserved during updates. Only the binary and driver DLLs are overwritten.

Muxit also checks for updates automatically on startup and can self-update via the UI.


Troubleshooting

Installer fails to download — Check your internet connection. The installer fetches from GitHub Releases. Corporate firewalls may block raw.githubusercontent.com.

Port 8765 already in use — Another instance of Muxit (or another program) is using the port. Stop the other process or use --port=9000 to pick a different port.

muxit command not found after install — Close and reopen your terminal. The installer adds the install directory to your user PATH, but existing terminal sessions need to be restarted.

Windows SmartScreen warning — On first run, Windows may show a SmartScreen warning because the binary isn't code-signed yet. Click "More info" then "Run anyway".

For more help, see the Troubleshooting Guide.


Building from Source

For developers and contributors only

If you want to build Muxit from source (for development or contributing):

Prerequisites

ToolVersionCheck
.NET SDK9.0 or laterdotnet --version
Node.js20 or laternode --version
GitAny recent versiongit --version

Build Steps

bash
git clone https://github.com/muxit-io/muxit-development.git
cd CENTRALCOMMAND
cd web-ui && npm install && cd ..
cd docs-site && npm install && cd ..
node build.js

Run from Source

bash
node start.js server

See the Development Guide for full details.

Muxit — Hardware Orchestration Platform