CLI Reference
CLI Reference
Generated command and option reference for the complete pmoke feature set.
Generated from typed clap metadata. Manual edits are overwritten.
Command index
| Command | Description | Feature |
|---|---|---|
pmoke show | Display the contents of the configuration file | core |
pmoke monitor | Open a live terminal dashboard for configuration and analysis artifacts | core |
pmoke config | Inspect and migrate configuration files | core |
pmoke raw | Inspect and verify stored RAW waveform data | core |
pmoke instruments | Inspect supported instruments and hardware capabilities | core |
pmoke bench | Benchmark instrument transport request latency | core |
pmoke export | Export stored data to interchange formats | core |
pmoke doctor | Diagnose config, storage, Python, and connected instruments | core |
pmoke single | Set single mode to the oscilloscope | hw-core |
pmoke trigger | Send trigger signal from the function generator | hw-core |
pmoke autoshot | Set single mode and send trigger signal | hw-core |
pmoke fetch | Fetch data from the oscilloscope and save to a file | hw-core |
pmoke screenshot | Capture an oscilloscope screenshot directly to the PC | hw-core |
pmoke automeasure | Perform auto measurement (set single mode, trigger, fetch) | hw-core |
pmoke reference | Fit the recorded EOM-drive sine wave | core |
pmoke sensor | Analyze the sensor signal | core |
pmoke li | Run numerical lock-in analysis | core |
pmoke phase | Rotate the reference phase for lock-in analysis | core |
pmoke kerr | Calculate the Kerr angle | core |
pmoke analyze | Run all analysis steps: reference, sensor, lock-in, phase, Kerr | core |
pmoke process | Automated analysis after manually triggering the pulse (fetch, lock-in, phase, Kerr) | hw-core |
pmoke auto | Run the full automatic measurement and analysis | hw-core |
pmoke completions | Generate shell completion script | core |
Global options
| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-c, --config <FILE> | - | config.toml | Path to the configuration file (default: ./config.toml) | - |
--run-dir <DIR> | - | - | Store and read run artifacts under this directory | - |
-f, --force | - | - | Overwrite existing run artifacts without error | - |
-h, --help | - | - | Print help | - |
-V, --version | - | - | Print version | - |
pmoke show
Display the contents of the configuration file
pmoke show [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke monitor
Open a live terminal dashboard for configuration and analysis artifacts
pmoke monitor [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke config
Inspect and migrate configuration files
pmoke config [-h, --help] <COMMAND>| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke config init
Create a starter config file
pmoke config init [--output <FILE>] [-f, --force] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--output <FILE> | - | - | Write the template to FILE instead of --config; use '-' for standard output | - |
-f, --force | - | - | Overwrite an existing output file | - |
-h, --help | - | - | Print help | - |
pmoke config validate
Validate the config file without running an analysis command
pmoke config validate [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke config explain
Explain config sections and fields
pmoke config explain [<PATH>] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
<PATH> | - | - | Field or section path to explain, for example lockin.filter | - |
-h, --help | - | - | Print help | - |
pmoke config migrate
Migrate the config to the latest executable schema
pmoke config migrate [--output <FILE>] [--in-place] [--check] [--accept-lossy] [--to <VERSION>] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--output <FILE> | - | - | Write the migrated TOML to FILE; use '-' for standard output | check, in_place |
--in-place | - | - | Atomically replace the source config after creating a versioned backup | check, output |
--check | - | - | Only report whether a migration is required | in_place, output |
--accept-lossy | - | - | Accept migration steps that can change legacy behavior | - |
--to <VERSION> | - | - | Require a specific target version instead of the latest executable version | - |
-h, --help | - | - | Print help | - |
pmoke raw
Inspect and verify stored RAW waveform data
pmoke raw [-h, --help] <COMMAND>| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke raw verify
Verify RAW metadata, file sizes, and available checksums
pmoke raw verify [--input <DIR>] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--input <DIR> | - | - | RAW acquisition directory (defaults to acquisition/ with legacy fallback) | - |
-h, --help | - | - | Print help | - |
pmoke instruments
Inspect supported instruments and hardware capabilities
pmoke instruments [-h, --help] <COMMAND>| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke instruments list
List supported instrument models
pmoke instruments list [--json] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--json | - | - | Emit machine-readable JSON | - |
-h, --help | - | - | Print help | - |
pmoke instruments explain
Explain a supported instrument model
pmoke instruments explain <MODEL> [--json] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
<MODEL> | yes | - | Instrument model name, for example Keithley2010 | - |
--json | - | - | Emit machine-readable JSON | - |
-h, --help | - | - | Print help | - |
pmoke instruments query
Send one SCPI text query to a connection URI
pmoke instruments query --connection <URI> [--timeout-ms <MS>] [--json] <COMMAND> [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--connection <URI> | yes | - | Connection URI, for example prologix-tcp://host:1234?addr=17 | - |
--timeout-ms <MS> | - | 3000 | Timeout used when the URI does not include a transport-specific timeout | - |
--json | - | - | Emit machine-readable JSON | - |
<COMMAND> | yes | - | SCPI query command, for example *IDN? | - |
-h, --help | - | - | Print help | - |
pmoke bench
Benchmark instrument transport request latency
pmoke bench [-h, --help] <COMMAND>| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke bench scpi-query
Benchmark one SCPI query and save a compact reproducibility report
pmoke bench scpi-query --connection <URI> [--command <COMMAND>] [-n, --iterations <N>] [--warmup <N>] [--timeout-ms <MS>] [-o, --output <FILE>] [--json] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--connection <URI> | yes | - | Connection URI accepted by pmoke instruments query | - |
--command <COMMAND> | - | *IDN? | SCPI query command to benchmark | - |
-n, --iterations <N> | - | 50 | Measured query count | - |
--warmup <N> | - | 3 | Unmeasured query count before measurement | - |
--timeout-ms <MS> | - | 3000 | Timeout used when the URI has no transport-specific timeout | - |
-o, --output <FILE> | - | - | Save TOML to FILE instead of the run benchmark directory | - |
--json | - | - | Emit the compact report as JSON after saving TOML | - |
-h, --help | - | - | Print help | - |
pmoke bench transport
Measure text request/response latency for a connection URI
pmoke bench transport --connection <URI> [--protocol <PROTOCOL>] [-r, --request <TEXT>] [-n, --iterations <N>] [--warmup <N>] [--timeout-ms <MS>] [-o, --output <FILE>] [--json] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--connection <URI> | yes | - | Connection URI accepted by pmoke instruments query | - |
--protocol <PROTOCOL> | - | scpi; scpi, line | Text protocol used to validate each request | - |
-r, --request <TEXT> | - | *IDN? | Request to benchmark; repeat for multiple requests | - |
-n, --iterations <N> | - | 50 | Measured request count per request | - |
--warmup <N> | - | 3 | Unmeasured request count before each measurement | - |
--timeout-ms <MS> | - | 3000 | Timeout used when the URI has no transport-specific timeout | - |
-o, --output <FILE> | - | - | Save the complete JSON report to a file | - |
--json | - | - | Emit the complete report as JSON | - |
-h, --help | - | - | Print help (see a summary with '-h') | - |
pmoke export
Export stored data to interchange formats
pmoke export [-h, --help] <COMMAND>| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke export csv
Convert a verified RAW waveform directory to CSV
pmoke export csv [--input <DIR>] [--output <FILE>] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--input <DIR> | - | - | RAW acquisition directory (defaults to acquisition/ with legacy fallback) | - |
--output <FILE> | - | - | CSV destination (defaults to acquisition/waveforms/waveform.csv) | - |
-h, --help | - | - | Print help | - |
pmoke export npy
Convert analysis result CSV files to NumPy tables
pmoke export npy [--output <DIR>] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--output <DIR> | - | - | Destination directory (defaults to NPY files beside canonical analysis CSVs) | - |
-h, --help | - | - | Print help | - |
pmoke doctor
Diagnose config, storage, Python, and connected instruments
pmoke doctor [--json] [--probe-fetch] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--json | - | - | Emit a machine-readable JSON report | - |
--probe-fetch | - | - | Allow active checks such as stopping the oscilloscope | - |
-h, --help | - | - | Print help | - |
pmoke single
Set single mode to the oscilloscope
Required feature:
hw-core
pmoke single [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke trigger
Send trigger signal from the function generator
Required feature:
hw-core
pmoke trigger [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke autoshot
Set single mode and send trigger signal
Required feature:
hw-core
pmoke autoshot [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke fetch
Fetch data from the oscilloscope and save to a file
Required feature:
hw-core
pmoke fetch [--format <FORMAT>] [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
--format <FORMAT> | - | csv, raw, csv-and-raw | Override output format from config [fetch].output | - |
-h, --help | - | - | Print help | - |
pmoke screenshot
Capture an oscilloscope screenshot directly to the PC
Required feature:
hw-core
pmoke screenshot [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke automeasure
Perform auto measurement (set single mode, trigger, fetch)
Required feature:
hw-core
pmoke automeasure [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke reference
Fit the recorded EOM-drive sine wave
pmoke reference [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke sensor
Analyze the sensor signal
pmoke sensor [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke li
Run numerical lock-in analysis
pmoke li [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke phase
Rotate the reference phase for lock-in analysis
pmoke phase [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke kerr
Calculate the Kerr angle
pmoke kerr [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke analyze
Run all analysis steps: reference, sensor, lock-in, phase, Kerr
pmoke analyze [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke process
Automated analysis after manually triggering the pulse (fetch, lock-in, phase, Kerr)
Required feature:
hw-core
pmoke process [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke auto
Run the full automatic measurement and analysis
Required feature:
hw-core
pmoke auto [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
-h, --help | - | - | Print help | - |
pmoke completions
Generate shell completion script
pmoke completions <SHELL> [-h, --help]| Option | Required | Default / values | Description | Conflicts |
|---|---|---|---|---|
<SHELL> | yes | bash, elvish, fish, powershell, zsh | Shell to generate for: bash, zsh, fish, powershell, elvish | - |
-h, --help | - | - | Print help | - |