CLI Reference

This section documents the public GONet Wizard command-line interface.

The CLI is useful for:

• Inspecting images and metadata from the terminal.

• Running repeatable extractions.

• Launching GUI-backed tools from scripts or shell commands.

• Processing groups of files with folders, wildcards, or comma-separated lists.

For a conceptual overview of the available tools, see Tools guide.

For implementation details about how commands are declared and dispatched, see command-system developer notes.

Important

The desktop installer/DMG is a GUI-first distribution path and does not add command-line entry points to your shell. To use this CLI reference, install the Python package with pip or pipx so that GONet_Wizard and gonet-wizard are available from the terminal.

Basic Usage

The general command structure is:

GONet_Wizard [global-options] <command> [command-options]

To show the top-level help page:

GONet_Wizard --help

To show help for a specific command:

GONet_Wizard show --help
GONet_Wizard extract --help

Available Commands

Command	Purpose	GUI equivalent
show	Inspect one or more GONet images by Bayer channel.	Show Image GUI guide
show_meta	Print or render metadata for one or more GONet images.	Show Metadata GUI guide
extract	Extract pixel-count measurements from selected image regions.	Extract GUI guide
split_raw	Convert original RAW GONet .jpg files into standard TIFF/JPEG products.	Split RAW Images GUI guide
dashboard	Launch the interactive dashboard from JSON or CSV data products.	Dashboard GUI guide
build_full_array	Build full-array GONet products by combining Bayer channels.	Command-line only
gui	Launch the graphical GONet Wizard launcher.	GUI launcher guide

Global Options

The top-level command supports several global options.

Option	Description
-h, --help	Show help text.
--version	Print the installed GONet Wizard version.
--ui-port UI_PORT	Port for the unified local UI server used by preview and GUI pages.
--debug-webview	Enable PyWebview debug mode.
--log-level LEVEL	Enable package logging at one of DEBUG, INFO, WARNING, ERROR, or CRITICAL.

Note

Global options are placed before the command name.

For example:

GONet_Wizard --log-level INFO show image.jpg

Command Pages

• Common CLI Patterns
  • Input Files and Folders
  • Multiple Separate Paths
  • Folders
  • Wildcards
  • Comma-Separated Lists
  • Long Path Examples
  • When Quotes Are Useful
  • Supported Image Extensions
  • Channel Flags
  • Output Paths
  • GUI-Backed Commands from the CLI
  • Missing Required Arguments
• show
  • Usage
  • Arguments
  • Options
  • Examples
  • GUI Equivalent
  • Related Pages
• show_meta
  • Usage
  • Arguments
  • Options
  • Examples
  • GUI Equivalent
  • Related Pages
• extract
  • Usage
  • Arguments
  • Launch Behavior
  • Channel Options
  • Shape Options
  • Angle Limits
  • Output Options
  • Interactive Runtime Options
  • Examples
  • GUI Equivalent
  • Related Pages
• split_raw
  • Usage
  • Arguments
  • Output Products
  • Options
  • Examples
  • GUI Equivalent
  • Related Pages
• dashboard
  • Usage
  • Arguments
  • Options
  • Examples
  • GUI Equivalent
  • Related Pages
• build_full_array
  • Intended Audience
  • Usage
  • Arguments
  • Options
  • Examples
  • GUI Equivalent
  • Related Pages
• gui
  • Usage
  • Options
  • Examples
  • Relationship to Other Commands
  • Related Pages

CLI Command Names and Tool Pages

Most commands correspond directly to a user-facing tool page.

Command	Tool page	Notes
show	image inspection tool guide	Opens image inspection previews.
show_meta	metadata inspection tool guide	Prints text output or returns HTML for GUI previews.
extract	extraction tool guide	Runs direct extraction or launches the interactive extraction app.
split_raw	split RAW images tool guide	Converts RAW GONet .jpg files into standard TIFF/JPEG products.
dashboard	dashboard tool guide	Launches a Dash application from JSON/CSV products.
build_full_array	No general user-facing tool page yet.	Advanced command-line-only workflow.
gui	GUI launcher guide	Opens the graphical launcher.

How the CLI Relates to Other Docs

The CLI Reference is intentionally practical: it shows command syntax, options, and examples.

For conceptual tool descriptions, see Tools guide. For GUI usage, see GUI Guide. For command-system internals, see command-system developer notes.