paradise-runner/toast
a batteries-included, beautiful, in-terminal IDE. Contribute to paradise-runner/toast development by creating an account on GitHub.
60 stars · 1 forks · 0 watchers
README
toast
toast is a beatiful developer environment right in your terminal. nvim and emacs have you build your editor from scratch, while toast ships with managed LSPs, an integrated file tree, multiple file tabs, and themes out of the box. toast is for the developer who wants to stay in their terminal without spending hours getting it up to snuff.
⚠️ This project is in early development, you may encounter bugs. ⚠️
Features
Multi-tab editing with unsaved-changes indicators, mouse-close buttons, and quit confirmation Syntax highlighting via tree-sitter (Go, Python, JavaScript, TypeScript, Rust, CSS, HTML, YAML, Bash, Markdown) Managed language servers — Toast offers to install missing servers for Go, Rust, Python, JavaScript, TypeScript, and Markdown (harper), with an extensible config for other languages Spell checking — misspelled words in Markdown and plain-text files are underlined in the theme's diagnostic color via harper Go to definition — hold Ctrl and hover to underline symbols with a target, then Ctrl-click to jump to the exact definition File tree sidebar with git status, ignored-file dimming, create/delete actions, file watching, and draggable resizing Project-wide search powered by rg (ripgrep) In-file find/replace with next/previous navigation, match-case, and whole-word options Markdown preview for .md, .markdown, and .mdx files Theme system — built-in system (derived from terminal colors at runtime), toast-dark, and toast-light, plus a VSCode theme importer Configurable via ~/.config/toast/config.json
Installation Homebrew (macOS) brew install paradise-runner/tap/toast Download a release Grab a zip for your platform from the releases page, unzip it, and place the binary on your $PATH:
example for Apple Silicon
curl -Lo toast.zip https://github.com/paradise-runner/toast/releases/latest/download/toast-darwin-arm64.zip unzip toast.zip install -m755 toast-darwin-arm64 /usr/local/bin/toast Build from source Requires Go 1.25.2+. git clone https://github.com/paradise-runner/toast cd toast make buildbinary written to bin/toast
Usage toast # open current directory toast path/to/dir # open a specific directory toast path/to/file # open a file (auto-detects git root) toast new/file.go # open a new file buffer if the parent directory exists toast --help toast --version rg is required for project search. When a built-in language server is missing, Toast shows an install prompt in the lower-right corner. Managed installs use the language's standard toolchain (go, npm, or rustup) or download a prebuilt binary (harper), and only run after you accept the prompt. Toast also uses compatible servers already on your $PATH. Keybindings All keybindings can be remapped in ~/.config/toast/config.json (see Configuration).Key Action
Ctrl+Q Quit
Ctrl+S / Cmd+S Save
Ctrl+W / Cmd+W Close tab
Ctrl+P Quick-open file search (fuzzy)
Ctrl+Alt+Right Next tab
Ctrl+Alt+Left Previous tab
Ctrl+B Toggle sidebar
Ctrl+Shift+E Toggle focus between editor and file tree
Ctrl+Shift+F Search
Ctrl+F / Cmd+F Find and replace in the current file
Ctrl+G / Cmd+L Go to line
Ctrl+Shift+M Toggle Markdown preview
Ctrl+Z / Cmd+Z Undo
Ctrl+Y / Ctrl+Shift+Z / Cmd+Y / Cmd+Shift+Z Redo
Ctrl+Space / Cmd+Space Trigger completion
Ctrl+Shift+K Show hover
Ctrl+hover / Ctrl-click Check for and follow a definition
F12 Go to the definition at the cursor
Configuration Toast reads ~/.config/toast/config.json on startup. Missing keys fall back to defaults. { "theme": "toast-dark", "editor": { "tab_width": 4, "auto_indent": true, "trim_trailing_whitespace_on_save": true, "insert_final_newline_on_save": true }, "sidebar": { "visible": true, "width": 30, "confirm_delete": true, "file_icons": { "enabled": true, "color_mode": "accent" } }, "ignored_patterns": [".git", "node_modules", "_pycache_", ".DS_Store"] } Keybindings All default keybindings can be overridden with the keybindings object. Each action accepts a list of key strings (supports ctrl, alt, shift, super modifiers). An empty list unbinds the action. { "keybindings": { "save": ["ctrl+s"], "quick_open": ["ctrl+o"], "next_tab": ["ctrl+tab"], "prev_tab": ["ctrl+shift+tab"], "quit": [] } } Available actions: quit, toggle_sidebar, save, new_file, close_tab, undo, redo, next_tab, prev_tab, search, find_replace, quick_open, go_to_line, go_to_definition, toggle_focus, markdown_preview, show_hover, trigger_completion. Omit lsp to use Toast's managed defaults for Go, Rust, Python, JavaScript, TypeScript, and Markdown; set "lsp": {} to disable all language servers. Entries in lsp override the managed default for that language, while unlisted managed languages keep their defaults — so a partial config never loses newly shipped servers. Each entry is extension-driven, so other languages can be added without changing Toast. A custom server already installed on $PATH only needs a command and its filename suffixes: { "lsp": { "zig": { "command": "zls", "args": [], "extensions": [".zig"] } } } For an opt-in managed custom server, add managed_command (the installed executable path) and an install recipe. Recipes support {install_dir}, {install_root}, {root_dir}, {home}, and {target} (the platform's Rust target triple, for per-platform prebuilt binaries) placeholders: { "lsp": { "example": { "command": "example-language-server", "args": ["--stdio"], "extensions": [".example"], "managed_command": "{install_dir}/bin/example-language-server", "install": { "name": "Example Language Server", "command": "example-package-manager", "args": ["install", "--bin-dir", "{install_dir}/bin", "example-language-server"], "env": {} } } } } Alternatively, an install recipe can download a prebuilt binary archive. The archive must contain a single executable file at its root (a wrapping top-level directory is tolerated); it is installed to {install_dir}/bin: { "lsp": { "example": { "command": "example-language-server", "args": ["--stdio"], "extensions": [".example"], "managed_command": "{install_dir}/bin/example-language-server", "install": { "name": "Example Language Server", "download": { "url": "https://github.com/org/example/releases/latest/download/example-ls-{target}.tar.gz" } } } } } Themes Built-in themes: system, toast-dark, toast-light. Custom themes live in ~/.config/toast/themes/. Import a VSCode theme: toast migrate-theme vscode path/to/theme.json