config.yaml

# GoShot Configuration File
# This file configures the behavior and appearance of your code screenshots.
# All settings can be overridden via command-line flags or environment variables.

# Input/Output settings
io:
  # Default output filename for screenshots. Supports templating with the following variables and functions:
  #
  # Template Functions:
  # - {{ formatDate "format" }} - Format current date/time (Go time format, e.g. "2006-01-02_15-04-05")
  #
  # File Variables (from input file):
  # - {{ .Filename }} - Input filename with extension (e.g., "code.go", "clipboard", or "stdin")
  # - {{ .FileBase }} - Input filename without extension (e.g., "code" or "goshot")
  # - {{ .FileExt }} - Input file extension with dot (e.g., ".go" or "")
  # - {{ .FileDir }} - Directory containing the input file (or cwd for clipboard/stdin)
  #
  # System Variables:
  # - {{ .User }} - Current username
  # - {{ .Host }} - Hostname
  # - {{ .Path }} - Current working directory
  #
  # Environment variables and ~ are automatically expanded in the path.
  #
  # Examples:
  # - "~/Pictures/Screenshots/{{ .FileBase }}_{{ formatDate \"2006-01-02_15-04-05\" }}.png"
  # - "$HOME/Screenshots/{{ .User }}/{{ formatDate \"2006-01-02\" }}/{{ .Filename }}.png"
  output_file: "code.png"
  # Automatically copy the generated image to clipboard (requires xclip, wl-clipboard, or pbcopy)
  copy_to_clipboard: false

# Appearance settings control the visual aspects of the screenshot
appearance:
  # Window chrome style: "mac", "windows", or "gnome"
  window_chrome: "mac"
  # Theme for window controls, leave empty for auto-detection
  chrome_theme_name: ""
  # Use light mode for syntax highlighting (same as setting chrome_theme_name to "light")
  light_mode: false
  # Syntax highlighting theme (e.g., "ayu-dark", "monokai", "github")
  theme: "ayu-dark"
  # Font family for code rendering (must be installed on system or embedded in binary)
  font: "JetBrainsMonoNerdFont"
  # Line height multiplier for code text
  line_height: 1.0
  
  # Background settings
  background:
    # Background color in hex format
    color: "#ABB8C3"
    # Optional background image
    image:
      # Path to image file
      source: ""
      # Image fit mode: "contain", "cover", "fill", "stretch", "tile"
      fit: "cover"
    # Gradient background settings
    gradient:
      # Gradient type: "linear", "radial", "angular", "diamond", "spiral", "square", "star"
      type: ""
      # List of color stops in format ["color;position", ...] (position: 0-100)
      stops: ["#232323;0", "#383838;100"]
      # Angle in degrees for linear gradients
      angle: 45
      # Center point for radial/angular gradients
      center:
        x: 0.5  # 0.0-1.0
        y: 0.5  # 0.0-1.0
      # Intensity of the gradient effect (1-10)
      intensity: 5
  
  # Drop shadow settings
  shadow:
    # Shadow color in hex format with alpha
    color: "#00000033"
    # Blur radius in pixels (if this is 0, no shadow will be applied)
    blur_radius: 0.0
    # Shadow spread in pixels
    spread: 0.0
    # Shadow offset
    offset:
      x: 0.0  # Horizontal offset in pixels
      y: 0.0  # Vertical offset in pixels
  
  # Show line numbers in code
  line_numbers: true
  # Corner radius for the entire image
  corner_radius: 10.0
  
  # Window appearance settings
  window:
    # Show window control buttons
    controls: true
    # Custom window title (empty for default)
    title: ""
    # Corner radius for window chrome
    corner_radius: 10.0
  
  # Layout and padding settings
  layout:
    # Padding between lines of code
    line_pad: 2
    # Outer padding
    padding:
      horizontal: 100
      vertical: 80
    # Code content padding
    code_padding:
      top: 10
      bottom: 10
      left: 10
      right: 10
    # Padding between line numbers and code
    line_number_padding: 10
    # Width constraints
    width:
      min: 0  # Minimum width in pixels (0 for auto)
      max: 0  # Maximum width in pixels (0 for auto)
    # Number of spaces for tab characters
    tab_width: 4

# Code redaction settings
redaction:
  # Enable redaction of sensitive information
  enabled: false
  # Redaction style: "block" (think CIA documents) or "blur" (more like a screenshot)
  style: "block"
  # Blur radius for blur style redaction
  blur_radius: 5.0
  # Regular expressions (PCRE) for automatic redaction
  patterns: []

# Terminal output settings (for exec command)
terminal:
  # Terminal dimensions
  width: 120   # Width in characters
  height: 40   # Height in characters
  # Automatically size terminal to content
  auto_size: false
  # Terminal content padding
  padding:
    left: 1
    right: 1
    top: 1
    bottom: 1
  # Spacing between cells in characters
  cell_spacing: 0
  # Show command prompt in output
  show_prompt: false
  # Prompt template with ANSI color codes
  prompt_template: "\x1b[1;35m❯ \x1b[0;32m{{ .Command }}\x1b[0m\n"