Moku API

# Moku CLI

Moku CLI (mokucli) is a powerful command line utility for managing Moku hardware devices. It provides comprehensive tools for MokuOS updates, instrument bitstream management, feature deployment, and device administration.

Read about how to install and use Moku CLI to:

  • Manage resources (MokuOS, instruments, and API servers), see the Quick start guide
  • Manage complex network and administration environments, see the Advanced usage guide

# Command Overview

MokuCLI is organized into command groups, each serving a specific purpose:

  1. instrument - Manage instrument bitstreams (download to cache, upload to device, list available)
  2. firmware - Manage device firmware updates
  3. feature - Manage software features and plugins (download to cache, upload to device)
  4. config - Configuration file management commands
  5. cache - Execute a single Moku API command.
  6. command - Convert Liquid Instruments binary data files to standard formats
  7. convert - Convert Liquid Instruments binary data files
  8. download - Legacy bitstream download (use instrument download)
  9. list - Search for Moku devices on network
  10. files - Manage files on Moku devices
  11. license - Manage device licenses
  12. proxy - Create network proxy to device
  13. stream - Stream real-time data from device
  14. mc - offline toolchain enabling offline Moku Compile builds
  15. login - Interactive sign-in and token refresh setup
  16. logout - Logout of current session and clear cached credentials

# Getting Help

To see available commands and options:

mokucli --help
mokucli COMMAND --help
1
2

For detailed information about each command, see the individual command pages linked above.

Install and quick start →