cli_reference
ispyisail edited this page 2026-09-17 13:11:09 +12:00
Clone

Wiki Page Revisions

4 Commits

Author SHA1 Message Date
ispyisail b0c030f682 Fix fabricated shortcuts and behaviors across four pages
Audited every English wiki page against source this session. Pages
already citing specific source files (variables.md, autonumbering.md,
element_editor.md, preferences.md, collection_browser.md and others
fixed earlier) held up under spot-checking. The four pages here had
none of that discipline applied and each repeated the same class of
fabricated claim, now checked and corrected:

- **Rotate is Space, not R.** R isn't bound to anything in the diagram
  editor -- checked ShortcutManager's registry directly.
- **Zoom in/out is the platform's standard zoom key, not bare +/-.**
  QKeySequence::ZoomIn/ZoomOut, not a literal + or - keypress.
- **Double-click on an element or wire opens its Properties dialog,
  not an inline text box.** Checked directly:
  QetGraphicsItem::mouseDoubleClickEvent() and
  Conductor::mouseDoubleClickEvent() both call editProperty(). Type
2026-09-17 13:11:09 +12:00
ispyisail 8df96757f3 Document JavaScript scripting (--run, Run Script...)
New page: scripting.md -- the two entry points, every qet.* method
(read the model, export/save, edit geometry with real undo, navigate/
message), three worked examples, exit codes, and the same limitations
the source's own class doc comment states, kept in sync deliberately.

Updates api_reference.md and cli_reference.md, both of which currently
say plainly that QET has no embedded scripting language -- true until
now. api_reference.md in particular carries a September 2026 correction
notice from when this page wrongly claimed Python scripting and a
plugin system existed; updated to state precisely what changed (a real
JavaScript engine) and what still has not (no plugin system, nothing
runs automatically, no project file can carry or trigger a script).

Status: describes PR #891, not yet merged into master. Every new/
changed section says so. Pushing now for discoverability rather than
waiting for merge, per explicit direction; drop the pending-PR notices
once #891 lands.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-16 20:29:49 +12:00
ispyisail 4854c314f0 Correct the automation docs: QET has no Python scripting and no plugins
api_reference stated "QElectroTech supports Python scripting" and
"QElectroTech supports plugins for deep integration", and told readers to
install plugins into ~/.local/share/QElectroTech/plugins/ and platform
equivalents. None of it exists: there is no QPluginLoader anywhere in
sources/, no plugin ABI, and every Python reference in the tree is the
launcher for qet_tb_generator -- a separate PyPI program QET starts as an
ordinary child process. QET never reads those plugin paths.

cli_reference had the mirror-image error, calling the shipped headless
export "Future CLI Features (QET 2.0)" and sending readers to the
scripting that does not exist. The FR/DE CLI pages additionally invented
a --dpi option and QET_PLUGIN_PATH / QET_ELEMENT_PATH, and documented an
argument order the parser cannot accept.

Rewrites api_reference (EN/FR/DE) around what is actually there: the 13
CLI verbs with their real positional syntax and exit codes, the real .qet
and .elmt XML (the old skeletons were invented -- no <diagrams> wrapper,
element has no id, uuid is an attribute), qet_tb_generator, and the C++
source. Adds a section naming what does not exist, so the claim does not
come back.

Also corrects the same claims where they had spread: features, history,
faq, user_manual (EN/FR/DE) and the sidebar.
2026-09-11 21:42:51 +12:00
ispyisail 92b48dd445 Add comprehensive CLI Reference page for command line usage
New CLI Reference page (1,200+ lines) covering:

Quick Start & Basic Usage:
- Launching QET from command line
- Opening single and multiple projects
- Platform-specific instructions (Windows, macOS, Linux)
- Help and version options

Command Line Options:
- File operations (--help, --version, --open)
- Platform-specific paths and aliases
- Project file arguments

Installation & Access:
- Windows PATH setup
- macOS aliases
- Linux package manager and AppImage usage

Common Workflows:
- Opening projects for editing
- Batch opening multiple files
- Integration with scripts
- Project with parameters

Scripting & Automation:
- Launching from Bash, Python, PowerShell
- Batch processing scripts
- Advanced automation techniques

Environment Variables:
- QET_PATH configuration
- Custom configuration directories
- Platform-specific settings

Exit Codes:
- Success (0) vs error (1, 2)
- Error checking in scripts

Troubleshooting:
- Command not found issues
- Permission problems
- File path issues
- Missing dependencies
- Library not found errors

Advanced Usage:
- Background operation
- Output capturing
- Multiple instances
- Cron/scheduled tasks

Limitations & Workarounds:
- Current CLI limitations (no headless, limited export)
- Recommended alternatives (Python scripting, plugins)
- Future CLI enhancements in QET 2.0

Integration Examples:
- Git integration
- File manager launchers
- IDE/editor integration

Best Practices:
- Script development guidelines
- Error handling examples
- Platform-specific tips

Quick Reference:
- Common commands table
- Usage examples

Comparison:
- GUI vs CLI vs Scripting for different tasks

Updates:
- Sidebar: Added CLI Reference under Development section

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GtMZqGEiUMvDBqcFvVG2vb
2026-09-09 15:35:53 +12:00