Skip to main content
Flume can generate scripts, themes, and layouts from natural language descriptions using your own LLM API key.

Setup

This walks you through interactively:
  1. Choose a provider — type 1 for Anthropic (Claude) or 2 for OpenAI (GPT)
  2. Paste your API key — stored automatically in the encrypted vault
The provider and model are saved to config.toml and the key to the vault. Works immediately in the same session — no restart needed. Or set up manually — see LLM Configuration.

Generate a Script

Use --name <name> to set the filename. Default language is Lua; use --python or --lua to choose.

Generate a Theme

Use --name <name> to set the theme filename. Without it, the name is derived from your description.

Generate a Layout

Layout generation creates a split profile — it picks which two buffers to show side-by-side and the split direction. It does not change the TUI chrome (panels, status bar).

Review and Accept

Generated content appears in a split preview pane with line numbers. Then:
  • Scripts are saved to scripts/generated/ and auto-loaded
  • Themes are saved to themes/ and applied immediately
  • Layouts are saved to layouts/ for use with /layout load