Files
spilltea/docs/basics.md
T
2026-05-30 00:14:54 +02:00

2.3 KiB

Project Management

Spilltea organizes work into projects. Each project maps to a SQLite database file that stores all intercepted traffic for that session & a log files.

On startup, you choose:

  • New project: enter a name, stored in ~/.local/share/spilltea/projects/ by default
  • Existing project: pick from a list of previous projects
  • Temporary: no name needed, stored in /tmp/spilltea/projects/ and will be deleted on your next reboot!

Configuration

Spilltea is fully configured via a YAML file at ~/.config/spilltea/config.yaml. Check the default configuration with all the options here

Colors and styles can be customized using ilovetui, which applies theme changes across all compatible TUI applications at once.

Per-project configuration

You can override any config value on a per-project basis by placing a config.yaml file inside the project directory (e.g. ~/.local/share/spilltea/projects/my-project/config.yaml).

Only the keys present in that file are overridden; everything else falls back to the global config.

The priority order is:

  1. Global config (~/.config/spilltea/config.yaml)
  2. Project config (<project-dir>/config.yaml)
  3. CLI flags (always win)

CLI Flags

A minimal, terminal-based HTTP(S) proxy for pentesters and CTF players.

Usage:
  spilltea [flags]

Flags:
      --add-default-config      copy the default config file to the config path and exit
      --add-default-plugins     copy built-in example plugins into the plugins dir and exit
  -c, --config string           path to config file
  -h, --help                    help for spilltea
      --host string             proxy host (overrides config)
      --plugins-dir string      path to plugins dir (overrides config)
  -p, --port int                proxy port (overrides config)
  -P, --project string          project name to open directly, or "tmp" for a temporary session
      --ssl-insecure            skip TLS certificate verification (overrides config)
      --upstream-proxy string   upstream proxy URL, e.g. http://user:pass@host:8888 (overrides config)
  -v, --version                 version for spilltea