Moku API

# mokucli files

Manage files on Moku devices

# Usage

$ mokucli files [OPTIONS] COMMAND [ARGS]...
1

# Commands

  • list: List files on the Moku
  • download: Download files from the Moku
  • delete: Delete files from the Moku

# mokucli files list

List files stored on the Moku device

# Usage

$ mokucli files list [OPTIONS] IP_ADDRESS
1

# Arguments

  • IP_ADDRESS: IP address of the Moku [required]

# Options

  • --name TEXT: Filter to apply (supports wildcards)
  • --help: Show this message and exit

# Examples

# List all files
mokucli files list 192.168.1.100

# List files containing "LockInAmplifier"
mokucli files list 192.168.1.100 --name "*LockInAmplifier*"

# List files with specific pattern
mokucli files list 192.168.1.100 --name "MokuDataLogger*2023*"
1
2
3
4
5
6
7
8

# Output

# list all files
$: mokucli files list 192.168.1.1
MokuLockInAmplifierData_20230207_071706.li
MokuDataLoggerData_20230206_155539.li

# list all files where the name contains LockInAmplifier
$: mokucli files list 192.168.1.1 --name "*LockInAmplifier*"
MokuLockInAmplifierData_20230207_071706.li
1
2
3
4
5
6
7
8

# mokucli files download

Download files from the Moku device

# Usage

$ mokucli files download [OPTIONS] IP_ADDRESS
1

# Arguments

  • IP_ADDRESS: IP address of the Moku [required]

# Options

  • --name TEXT: Filter to apply (supports wildcards)
  • --help: Show this message and exit

# Examples

# Download all files
mokucli files download 192.168.1.100

# Download files containing "LockInAmplifier"
mokucli files download 192.168.1.100 --name "*LockInAmplifier*"

# Download specific file pattern
mokucli files download 192.168.1.100 --name "MokuDataLogger*2023*"
1
2
3
4
5
6
7
8

# mokucli files delete

Delete files from the Moku device

Warning

Delete operations are permanent and cannot be undone

# Usage

$ mokucli files delete [OPTIONS] IP_ADDRESS
1

# Arguments

  • IP_ADDRESS: IP address of the Moku [required]

# Options

  • --name TEXT: Filter to apply (supports wildcards)
  • --help: Show this message and exit

# Examples

# Delete all files (use with caution!)
mokucli files delete 192.168.1.100

# Delete files containing "LockInAmplifier"
mokucli files delete 192.168.1.100 --name "*LockInAmplifier*"

# Delete old files
mokucli files delete 192.168.1.100 --name "*2022*"
1
2
3
4
5
6
7
8

# Notes

  • Files are typically data recordings from instruments (.li files)
  • Files may not always be in the .li format, for instance, if you're deleting files from an SD card mounted to a Moku:Lab, there may be existing files on the SD card that are not in the .li format
  • Downloaded files are saved to the current directory
  • The --name filter supports standard wildcards (* and ?)
  • Delete operations are permanent and cannot be undone

← license →