Docs/AgentEyes/CLI reference
AgentEyes

The agenteyes CLI

3 min read

agenteyes.exe is the AgentEyes engine as a command-line tool - the same engine the tray app uses. Use it to list devices, take screenshots, record audio and video, build a walkthrough, and run import, translate, and subtitle from a script. If you opted agenteyes onto your PATH at install, run it by name from any terminal.

Commands

agenteyes
agenteyes screens
agenteyes shot    --screen N [--region] [--out DIR] [--label NAME]
agenteyes audio   --screen N (--mic "NAME" | --loopback | --mix --mic "NAME") [--seconds N]
agenteyes video   --screen N [--mic "NAME"] [--mix | --loopback] [--region] [--seconds N]
     mic options:  --no-denoise  --no-gate  --no-level  --mic-vol PCT  --sys-vol PCT
agenteyes package <recording-dir | video.mp4> [--interval N | --scene THRESHOLD]
agenteyes import  <video.mp4>             # import an external video into the library
agenteyes translate <id> --to LANG        # translate a transcript into LANG (e.g. tr), timing preserved
agenteyes subtitle  <id> --lang LANG      # burn LANG captions into a new subtitled MP4 (ffmpeg)
agenteyes selftest                        # headless end-to-end self-test

What each command does

  • screens - list the monitors and microphones AgentEyes can see, with the index numbers you pass to --screen and the names you pass to --mic.
  • shot - take an instant screenshot of a monitor, or a region with --region.
  • audio - record microphone audio, system (loopback) audio, or a mix of both, with on-demand screenshots.
  • video - record screen video with audio; add --region to capture part of a screen. The mic options tune the audio (turn off denoise, the noise gate, or leveling, and set mic and system volume).
  • package - transcribe a recording and assemble the walkthrough write-up. Point it at a recording folder or a bare video file.
  • import - bring an outside video into the library and transcribe it. See Import a video.
  • translate - translate a recording's transcript into another language, timing preserved. See Multilingual subtitles.
  • subtitle - burn a language's captions into a new subtitled video.
  • selftest - run the headless end-to-end self-test.

Session hotkeys

While an audio or video session is running, these keys control it:

S = screenshot     P = pause/resume     Q = stop
Note
import and translate transcribe and translate through DevThrottle's hosted AI, so they need you to be signed in to DevThrottle and they send audio or text to the hosted service. shot, audio, video, and subtitle run locally.

Where to go next

To drive an already-running recorder instead of running one-off commands, see the Control API.