Skip to main content

Command Reference

This section documents the Snoopy CLI one command group at a time.

Top-Level Commands​

  • job
  • jobs
  • add
  • list
  • delete [jobRef]
  • start [jobRef]
  • stop [jobRef]
  • settings
  • daemon
  • startup
  • reboot
  • export
  • analytics [jobRef]
  • logs [runId]
  • errors [jobRef]
  • doctor

<jobRef> accepts either a job UUID or a slug.

For commands with [jobRef] or [runId], omitting the argument starts an interactive selector in TTY mode.

Per-Command Pages​

Top-Level Aliases​

Snoopy exposes a few top-level shortcuts for common actions.

add​

Alias for job add.

snoopy add

list​

Alias for jobs list.

snoopy list

delete [jobRef]​

Alias for job delete [jobRef].

snoopy delete
snoopy delete <jobRef>

start [jobRef]​

Alias for enabling a job.

snoopy start
snoopy start <jobRef>

stop [jobRef]​

Alias for disabling a job.

snoopy stop
snoopy stop <jobRef>

Typical Flow​

snoopy job add
snoopy job run --limit 5
snoopy job run <jobRef> --limit 5
snoopy job runs <jobRef>
snoopy analytics <jobRef>
snoopy export csv <jobRef>
snoopy logs
snoopy logs <runId>
snoopy errors <jobRef>
snoopy daemon start
snoopy doctor