🍞 Toast IDE: A Polished, Terminal-Based Development Environment

Welcome to Toast, a "batteries-included" IDE that lives entirely within your terminal. While tools like Neovim or Emacs require you to spend hours building your environment from the ground up, Toast provides a beautiful, ready-to-use experience immediately.

[!WARNING] Development Status: This project is currently in its early stages. Please be aware that you may encounter occasional bugs.

---

🚀 Core Capabilities

Toast is designed for developers who want the power of a full IDE without the configuration headache.

🛠️ Editor Features

• Advanced Tab Management: Edit multiple files simultaneously with indicators for unsaved changes, mouse-driven close buttons, and prompts before quitting.
• Rich Syntax Highlighting: Powered by tree-sitter, supporting:
  • Backend: Go, Rust, Python
  • Frontend: JavaScript, TypeScript, CSS, HTML
  • Config/Scripts: YAML, Bash, Markdown
• Intelligent Navigation:
  • Go to Definition: Hold Ctrl and hover to highlight targets; Ctrl + Click to jump directly to the source.
  • Quick Search: Project-wide searching via rg (ripgrep) and robust in-file find/replace (supporting case-sensitivity and whole-word matching).
• Markdown Integration:
  • Full preview support for .md, .markdown, and .mdx files.
  • Spell Checking: Integrated via harper, underlining errors in Markdown and plain-text files using your theme's diagnostic color.

📂 Workspace & Aesthetics

• File Tree Sidebar: Includes Git status integration, dimming for ignored files, file watching, and the ability to create/delete files or resize the panel via dragging.
• Theming Engine:
  • Dynamic system theme (based on terminal colors).
  • Dedicated toast-dark and toast-light modes.
  • Ability to import themes from VSCode.

---

📦 Installation & Setup

Quick Start Checklist

• Install ripgrep (required for project search)
• Choose installation method below
• Launch toast in your project folder

Installation Methods

1. Homebrew (macOS)

brew install paradise-runner/tap/toast

2. Binary Release

Download the appropriate zip from the releases page, extract it, and move the binary to 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

3. Build from Source

Requires Go version $\ge 1.25.2$.

git clone https://github.com/paradise-runner/toast
cd toast
make build # Output binary located at bin/toast

---

📖 Usage Guide

Managed Language Servers (LSPs)

Toast simplifies LSP management. If a required server is missing for Go, Rust, Python, JS, TS, or Markdown (harper), a prompt will appear in the bottom-right corner.

---

⌨️ Keybindings

All defaults can be customized in your config file.

---

⚙️ Configuration

Toast utilizes a JSON file located at ~/.config/toast/config.json.

General Settings

{
  "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"]
}

Customizing Keybindings

You can override any default action by adding a keybindings object.

{
  "keybindings": {
    "save": ["ctrl+s"],
    "quick_open": ["ctrl+o"],
    "next_tab": ["ctrl+tab"],
    "prev_tab": ["ctrl+shift+tab"],
    "quit": [] 
  }
}

Available actions include: 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.

LSP Configuration

To use Toast's managed defaults, simply omit the lsp key. To disable all servers, set "lsp": {}. You can also provide specific overrides for individual languages within the lsp object.

Developer Efficiency Formula: $\text{Efficiency} = \frac{\text{Features}}{\text{Config Time}} \times \text{Beauty}$