CLI reference
CLI reference
Operator tools install to /opt/pixop/bin on the appliance guest and are on PATH for ec2-user. They self-elevate with sudo when needed — do not prefix guest commands with sudo.
The only documented exception is KVM host pixop-install: from the extracted installer archive root (directory that contains scripts/), run sudo ./scripts/pixop-install. See KVM quickstart.
Navigation in ReadMe mirrors this page: four expandable groups under CLI reference, plus host-only install under KVM quickstart.
Safe first diagnostic flow
Run on the guest before restarting services or capturing streams:
pixop-version
pixop-preflight
pixop-healthcheck
pixop-stack status
pixop-flow --secs 5| Step | Group | Why |
|---|---|---|
| Version and preflight | Health and diagnostics | Confirms recipe and catches license/unit/GPU issues |
| Stack status | Service and processing | Shows whether LIVE and TSDuck are up |
| Flow snapshot | Streams and networking | Confirms bitrate movement on SRT |
If you need a support archive, continue with Licensing and support (pixop-support-bundle after you understand what it may contain).
Command lookup by task
| Task | Commands | Group |
|---|---|---|
| Start/stop pipeline | pixop-stack, pixopctl, tsduckctl | Service and processing |
| SRT / TS troubleshooting | pixop-flow, pixop-net, tsduck-transport-info, pixop-probe-input, pixop-tap-input, pixop-timing-probe | Streams and networking |
| Health / acceptance | pixop-version, pixop-preflight, pixop-healthcheck, pixop-startup-timeline, pixop-test-live | Health and diagnostics |
| License and support | pixop-license, pixop-decode-jwt, pixop-support-bundle, pixop-pack-config, pixop-pack-logs | Licensing and support |
| Offline files | pixop-process | Service and processing |
| Container digest update | pixop-image-update | Service and processing |
| NVENC diagnostics | pixop-nvencc | Service and processing |
| KVM VM install (host) | pixop-install | pixop-install · KVM quickstart |
Service and processing
pixop-stack · pixopctl · tsduckctl · pixop-process · pixop-image-update · pixop-nvencc
Streams and networking
pixop-flow · pixop-net · tsduck-transport-info · pixop-probe-input · pixop-tap-input · pixop-timing-probe
Health and diagnostics
pixop-version · pixop-preflight · pixop-healthcheck · pixop-startup-timeline · pixop-test-live
Licensing and support
pixop-license · pixop-decode-jwt · pixop-support-bundle · pixop-pack-config · pixop-pack-logs
Platform and permissions
| Surface | AWS Marketplace guest | KVM guest | KVM host |
|---|---|---|---|
| SSH user | ec2-user | ec2-user | your admin user |
| CLI path | /opt/pixop/bin | same | installer bundle only (pixop-install) |
sudo | Tools self-elevate | same | Required for pixop-install |
| Licensing | AWS License Manager via pixop-license | JWT file | N/A (guest licensing) |
Read-only vs mutating
- Mostly read-only:
pixop-version,pixop-healthcheck,pixop-flow(snapshot),pixop-net summary, manytsduckctl checkand transport-info modes. pixop-preflight does not change configuration or restart services but uses ephemeral write probes under/var/lib/pixop-live/parametersand a short-livedmktempfile when inspecting a running container. - Mutating:
pixop-stack start|stop|restart,pixopctl start|stop,tsduckctl--applyoperations,pixop-process,pixop-image-updateapply paths,pixop-test-live, hostpixop-install install.
When unsure, use dry-run or help flags documented on each command page.
Version availability
| Identifier | Where | CLI notes |
|---|---|---|
| Marketplace product version | AWS listing / delivery | Procurement record; not the same as the guest recipe |
| AMI recipe | pixop-version on the instance | Authoritative for which commands and transport class are installed |
Do not assume release notes or this reference describe your disk until pixop-version, command -v <tool>, and -h / --help confirm it.
Sensitive output
- SRT URLs and passphrases may appear in
tsduckctl, tap, or transport tools. - License JWTs (
/etc/pixop-live/license.jwt) andpixop-license tokenoutput (same compact JWT) are secrets;pulse.envcredentials are separate secrets. - Support bundles and log packs use best-effort redaction — review before sharing.
Internal entrypoints (not operator CLI)
The following exist on some images for bootstrapping, marketplace integration, or engineering workflows. Do not document them as supported operator commands and do not invoke them unless Pixop support directs you:
pixop-marketplace, pixop-instance-init, pixop-live-run, pixop-logclean, pixop-redact, tsduck-in-run, tsduck-out-run, and similar bake-time helpers.
Use the grouped commands above for day-two operations.
Related guides
Updated about 8 hours ago