Skip to main content

CLI Overview

Goal​

Pick the right keypress command quickly, without digging through internals.

Prerequisites​

  • Keypress installed and available in your terminal

What Should I Run?​

  • Start a normal session: keypress
  • Start Codex mode: keypress codex
  • Start Gemini mode: keypress gemini
  • Manage login: keypress auth ...
  • Connect vendors: keypress connect ...
  • Diagnose issues: keypress doctor
  • Manage background helper: keypress daemon ...

Startup Launcher Tips​

  • Show launcher on no-arg run: keypress --menu
  • Skip launcher on no-arg run: keypress --no-menu
  • Global preference:
    • KEYPRESS_STARTUP_MENU=0 disable launcher
    • KEYPRESS_STARTUP_MENU=1 enable launcher
Screenshot Placeholder
  • What to capture: Startup launcher menu with available actions.
  • Why this screenshot matters: Helps users understand no-argument behavior before choosing defaults.
  • Suggested filename: cli-overview-startup-launcher.png

Expected Result​

You know which top-level command to use for your current task.

Next Step​

Use Commands for concise command reference.