Installation
Get Muxit running on your machine in under a minute.
Quick Install (Recommended)
Open PowerShell and run:
irm https://raw.githubusercontent.com/muxit-io/muxit/main/install.ps1 | iexThis 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:
- Go to the GitHub Releases page
- Download
muxit-win-x64-v<version>.zip(the file name includes the release version) - Extract the zip to a folder of your choice (e.g.
C:\muxit) - Run
muxit.exefrom the extracted folder
System Requirements
| Requirement | Details |
|---|---|
| OS | Windows 10 or later (x64) |
| Runtime | None — self-contained binary, no .NET or Node.js needed |
| Disk space | ~150 MB |
| Network | Required for AI features and license activation; optional otherwise |
First Run
After installing, start Muxit:
muxitThis 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:
muxit # Start without opening browser
muxit --no-tray # Start without system tray icon
muxit --port=9000 # Use a custom portVerify It Works
Once the server is running and the browser opens:
- 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.)
- Open a demo dashboard — In the Explorer sidebar, expand
dashboards/and clickdemo.dashboard.json. You should see live gauges and widgets - Run a script — In the Explorer sidebar, expand
scripts/and clickhello.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:
| Category | What's Included |
|---|---|
| MuxitServer | Self-contained .NET 9.0 binary (no runtime install needed) |
| Built-in drivers | TestDevice, Webcam, ONVIF (IP camera), FileAccess, MqttBridge |
| Example connectors | test-device, webcam, gui, store, and more in workspace/connectors/ |
| Example scripts | hello.js, demo.js, count_to_ten.js, stream-demo.js, and more |
| Example dashboards | demo, test-device, robot, gcode, and more |
| Example agents | temperature-monitor, pick-and-place |
| Documentation | Built-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:
irm https://raw.githubusercontent.com/muxit-io/muxit/main/install.ps1 | iexYour 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
| Tool | Version | Check |
|---|---|---|
| .NET SDK | 9.0 or later | dotnet --version |
| Node.js | 20 or later | node --version |
| Git | Any recent version | git --version |
Build Steps
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.jsRun from Source
node start.js serverSee the Development Guide for full details.