CLI リファレンス

pmokeの全featureを対象とする、commandとoptionの自動生成リファレンス。

型付きclap metadataから自動生成。手動編集は上書き対象。

pmoke: 0.4.0
config schema: 5
source: 9107b7e40779

コマンド索引

コマンド	説明	必要なfeature
`pmoke show`	設定ファイルの内容表示	core
`pmoke monitor`	設定・解析artifactのライブ端末ダッシュボード	core
`pmoke config`	設定ファイルの確認・移行	core
`pmoke raw`	保存済みRAW波形の確認・検証	core
`pmoke instruments`	対応装置とhardware capabilityの確認	core
`pmoke bench`	装置transportのリクエスト遅延benchmark	core
`pmoke export`	保存データの交換形式export	core
`pmoke doctor`	設定、ストレージ、Python、接続装置の診断	core
`pmoke single`	オシロスコープのsingle mode設定	hw-core
`pmoke trigger`	ファンクションジェネレータからのtrigger送信	hw-core
`pmoke autoshot`	single mode設定とtrigger送信	hw-core
`pmoke fetch`	オシロスコープデータの取得・保存	hw-core
`pmoke screenshot`	オシロスコープ画面のPC直接取得	hw-core
`pmoke automeasure`	single mode・trigger・fetchの自動測定	hw-core
`pmoke reference`	記録したEOM駆動正弦波をフィッティング	core
`pmoke sensor`	センサー信号解析	core
`pmoke li`	数値lock-in解析	core
`pmoke phase`	lock-in解析の参照位相回転	core
`pmoke kerr`	Kerr角度を計算	core
`pmoke analyze`	reference・sensor・lock-in・phase・Kerrの全解析	core
`pmoke process`	手動pulse trigger後のfetch・lock-in・phase・Kerr自動解析	hw-core
`pmoke auto`	完全自動測定・解析	hw-core
`pmoke completions`	shell completion scriptの生成	core

グローバル option

option	必須	既定値 / 候補	説明	競合
`-c, --config <FILE>`	-	`config.toml`	設定ファイルpath。既定値./config.toml。	-
`--run-dir <DIR>`	-	-	run artifactを保存・読み込むdirectory	-
`-f, --force`	-	-	既存run artifactの上書き許可	-
`-h, --help`	-	-	help表示	-
`-V, --version`	-	-	version表示	-

`pmoke show`

設定ファイルの内容表示

pmoke show [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke monitor`

設定・解析artifactのライブ端末ダッシュボード

pmoke monitor [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke config`

設定ファイルの確認・移行

pmoke config [-h, --help] <COMMAND>

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke config init`

初期設定ファイルの生成

pmoke config init [--output <FILE>] [-f, --force] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--output <FILE>`	-	-	--configの代わりにFILEへtemplate出力。標準出力は'-'。	-
`-f, --force`	-	-	既存出力ファイルの上書き許可	-
`-h, --help`	-	-	help表示	-

`pmoke config validate`

解析を伴わない設定ファイル検証

pmoke config validate [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke config explain`

設定section・fieldの説明

pmoke config explain [<PATH>] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`<PATH>`	-	-	説明対象fieldまたはsection path。例: lockin.filter。	-
`-h, --help`	-	-	help表示	-

`pmoke config migrate`

設定の最新実行可能schemaへの移行

pmoke config migrate [--output <FILE>] [--in-place] [--check] [--accept-lossy] [--to <VERSION>] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--output <FILE>`	-	-	移行済みTOMLのFILE出力。標準出力は'-'。	`check`, `in_place`
`--in-place`	-	-	version付きbackup作成後の設定原本のatomic置換	`check`, `output`
`--check`	-	-	移行要否のみの報告	`in_place`, `output`
`--accept-lossy`	-	-	legacy動作を変更し得る移行stepの許可	-
`--to <VERSION>`	-	-	最新実行可能版に代わる移行先versionの固定	-
`-h, --help`	-	-	help表示	-

`pmoke raw`

保存済みRAW波形の確認・検証

pmoke raw [-h, --help] <COMMAND>

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke raw verify`

RAW metadata・file size・checksumの検証

pmoke raw verify [--input <DIR>] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--input <DIR>`	-	-	RAW取得directory。既定値acquisition/、legacy fallbackあり。	-
`-h, --help`	-	-	help表示	-

`pmoke instruments`

対応装置とhardware capabilityの確認

pmoke instruments [-h, --help] <COMMAND>

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke instruments list`

対応装置モデル一覧

pmoke instruments list [--json] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--json`	-	-	machine-readable JSON出力	-
`-h, --help`	-	-	help表示	-

`pmoke instruments explain`

対応装置モデルの説明

pmoke instruments explain <MODEL> [--json] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`<MODEL>`	必須	-	装置モデル名。例: Keithley2010。	-
`--json`	-	-	machine-readable JSON出力	-
`-h, --help`	-	-	help表示	-

`pmoke instruments query`

接続URIへの単一SCPI text query

pmoke instruments query --connection <URI> [--timeout-ms <MS>] [--json] <COMMAND> [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--connection <URI>`	必須	-	接続URI。例: prologix-tcp://host:1234?addr=17。	-
`--timeout-ms <MS>`	-	`3000`	URIにtransport固有のtimeoutがない場合に使用するtimeout	-
`--json`	-	-	machine-readable JSON出力	-
`<COMMAND>`	必須	-	SCPI query command。例: *IDN?。	-
`-h, --help`	-	-	help表示	-

`pmoke bench`

装置transportのリクエスト遅延benchmark

pmoke bench [-h, --help] <COMMAND>

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke bench scpi-query`

単一SCPI queryのbenchmarkと再現性report保存

pmoke bench scpi-query --connection <URI> [--command <COMMAND>] [-n, --iterations <N>] [--warmup <N>] [--timeout-ms <MS>] [-o, --output <FILE>] [--json] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--connection <URI>`	必須	-	`pmoke instruments query`で使用する接続URI	-
`--command <COMMAND>`	-	`*IDN?`	benchmark対象のSCPI query command	-
`-n, --iterations <N>`	-	`50`	計測するquery回数	-
`--warmup <N>`	-	`3`	計測前に実行する非記録query回数	-
`--timeout-ms <MS>`	-	`3000`	URIにtransport固有のtimeoutがない場合に使用するtimeout	-
`-o, --output <FILE>`	-	-	run benchmark directoryに代わるFILEへのTOML保存	-
`--json`	-	-	TOML保存後のcompact report JSON出力	-
`-h, --help`	-	-	help表示	-

`pmoke bench transport`

接続URIのtext request/response latency計測

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	必須	既定値 / 候補	説明	競合
`--connection <URI>`	必須	-	`pmoke instruments query`で使用する接続URI	-
`--protocol <PROTOCOL>`	-	`scpi`; `scpi`, `line`	各requestを検証するtext protocol	-
`-r, --request <TEXT>`	-	`*IDN?`	benchmark対象request。複数指定時の反復option。	-
`-n, --iterations <N>`	-	`50`	requestごとの計測回数	-
`--warmup <N>`	-	`3`	各計測前に実行する非記録request回数	-
`--timeout-ms <MS>`	-	`3000`	URIにtransport固有のtimeoutがない場合に使用するtimeout	-
`-o, --output <FILE>`	-	-	完全JSON reportのファイル保存	-
`--json`	-	-	完全reportのJSON出力	-
`-h, --help`	-	-	help表示	-

`pmoke export`

保存データの交換形式export

pmoke export [-h, --help] <COMMAND>

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke export csv`

検証済みRAW波形directoryのCSV変換

pmoke export csv [--input <DIR>] [--output <FILE>] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--input <DIR>`	-	-	RAW取得directory。既定値acquisition/、legacy fallbackあり。	-
`--output <FILE>`	-	-	CSV出力先。既定値acquisition/waveforms/waveform.csv。	-
`-h, --help`	-	-	help表示	-

`pmoke export npy`

解析結果CSVのNumPy table変換

pmoke export npy [--output <DIR>] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--output <DIR>`	-	-	出力directory。既定値は標準解析CSVと同じ場所のNPY。	-
`-h, --help`	-	-	help表示	-

`pmoke doctor`

設定、ストレージ、Python、接続装置の診断

pmoke doctor [--json] [--probe-fetch] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--json`	-	-	machine-readable JSON report出力	-
`--probe-fetch`	-	-	オシロスコープ停止などのactive check許可	-
`-h, --help`	-	-	help表示	-

`pmoke single`

オシロスコープのsingle mode設定

必要なfeature: hw-core

pmoke single [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke trigger`

ファンクションジェネレータからのtrigger送信

必要なfeature: hw-core

pmoke trigger [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke autoshot`

single mode設定とtrigger送信

必要なfeature: hw-core

pmoke autoshot [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke fetch`

オシロスコープデータの取得・保存

必要なfeature: hw-core

pmoke fetch [--format <FORMAT>] [-h, --help]

option	必須	既定値 / 候補	説明	競合
`--format <FORMAT>`	-	`csv`, `raw`, `csv-and-raw`	config [fetch].outputに対する出力形式override	-
`-h, --help`	-	-	help表示	-

`pmoke screenshot`

オシロスコープ画面のPC直接取得

必要なfeature: hw-core

pmoke screenshot [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke automeasure`

single mode・trigger・fetchの自動測定

必要なfeature: hw-core

pmoke automeasure [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke reference`

記録したEOM駆動正弦波をフィッティング

pmoke reference [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke sensor`

センサー信号解析

pmoke sensor [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke li`

数値lock-in解析

pmoke li [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke phase`

lock-in解析の参照位相回転

pmoke phase [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke kerr`

Kerr角度を計算

pmoke kerr [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke analyze`

reference・sensor・lock-in・phase・Kerrの全解析

pmoke analyze [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke process`

手動pulse trigger後のfetch・lock-in・phase・Kerr自動解析

必要なfeature: hw-core

pmoke process [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke auto`

完全自動測定・解析

必要なfeature: hw-core

pmoke auto [-h, --help]

option	必須	既定値 / 候補	説明	競合
`-h, --help`	-	-	help表示	-

`pmoke completions`

shell completion scriptの生成

pmoke completions <SHELL> [-h, --help]

option	必須	既定値 / 候補	説明	競合
`<SHELL>`	必須	`bash`, `elvish`, `fish`, `powershell`, `zsh`	生成対象shell: bash、zsh、fish、powershell、elvish。	-
`-h, --help`	-	-	help表示	-

CLI リファレンス

目次