Moku API

# Installation

The latest packages are available to download from Utilities (opens new window). The installation wizard will configure everything needed to launch and update the CLI successfully.

# Search Path Configuration

# Windows and Mac

When using the installers, mokucli will be automatically discoverable from any client driver package (e.g., MATLAB or Python).

# Linux

For Linux users, you must manually either:

  1. Extract the contents and create a symbolic link to mokucli in the /usr/local/bin directory, or
  2. Set the MOKU_CLI_PATH environment variable to the absolute path of mokucli

# Quick Start

# Download and install workflow

MokuCLI follows a two-step workflow for managing resources (MokuOS, instruments, features such as rest-api):

  1. Download - Resources are first downloaded to your local cache
  2. Install/Upload - Resources are then installed from the local cache to Moku devices

This approach enables:

  • Offline installations - Install local cached resource without internet connectivity.
  • Bulk deployments - Deploy the same resources to multiple devices efficiently
  • API integration - The Moku API can install instruments on-demand from the local cache
  • Faster reinstalls - Resources are cached locally for quick access

Here are some common mokucli commands to get you started:

# Finding devices

# List all Moku devices on your network
mokucli list
1
2

# Downloading the instruments for API use

# Download all bitstreams for version 4.0.1 to local cache
mokucli instrument download 4.0.1
1
2

# Downloading resources for offline use

# Download a specific bitstream
mokucli instrument download 4.0.1:oscilloscope --hw-version mokugo

# Download features for offline installation
mokucli feature download 4.0.1:api-server --hw-version mokupro
1
2
3
4
5

# Uploading firmware

# Upload firmware version 4.0.1 to a device
mokucli firmware upload 192.168.1.100 4.0.1

# Upload a local firmware version 611
mokucli firmware upload 192.168.1.100 611
1
2
3
4
5

# Managing instruments on device

# Upload a single instrument oscilloscope to a device
mokucli instrument upload 192.168.1.100 4.0.1:oscilloscope

# Upload multiple bitstreams, this uploads all downloaded single instruments
mokucli instrument upload 192.168.1.100 "4.0.1:01-*"
1
2
3
4
5

For more details on the supported syntax, see the mokucli instrument upload documentation

# Remove MokuCLI

To remove mokucli, see the Knowledge Base article (opens new window) for removal on your operating system.

← Advanced usage →