toe

module
v0.1.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 28, 2026 License: MIT

README

Thom's Own Editor (toe)

Build Status Code Coverage Maintainability GitHub

toe is a modal terminal editor for Go development. toe edits Go projects, not the universe.

Experimental but usable. Keep your work in Git or another backup.

toe screenshot

Super Opinionated

toe is opinionated because it is built for one tight workflow: editing Go projects from a terminal without growing into a general-purpose IDE. It favors modal editing, gopls, TOML config, project-local state, Git diff gutters and a changed-file picker, and a small set of deliberate defaults over plugin sprawl or endless knobs.

  • Modal editing: normal, insert, and selection modes; multi-cursor editing; undo and redo
  • Project navigation: multiple buffers, split views, fuzzy file/buffer pickers, global search, file and diff previews, image panes, and an integrated terminal pane
  • Go-focused language tooling: syntax highlighting, LSP completion, hover, signature help, formatting, symbols, code actions, rename, go-to navigation, and diagnostics
  • Editor display: soft wrap, rulers, whitespace rendering, indent guides, gutters, configurable cursor shapes, and statusline elements
  • Version control: git diff gutters, changed-hunk navigation and reset, and a changed-file picker with unified diff previews
  • Project state: workspace trust, user/workspace TOML config, EditorConfig, session persistence, external file change detection, and clean-buffer reloads
  • 4 Catppuccin themes: frappe, latte, macchiato, mocha

Requirements

  • Go 1.26 when building from source
  • A terminal with ANSI color support
  • gopls on PATH for Go language features
  • A Kitty graphics capable terminal
  • Nerd Font glyphs for enhanced UI

Install

Install the latest stable release with Homebrew (recommended):

brew install kode4food/tap/toe

To build the current source:

make build    # writes to dist/toe
make install  # installs to $GOPATH/bin

Usage

toe
toe path/to/file.go
toe file1 file2
toe path/to/project

When the first argument is a directory, toe uses it as the project root.

Configuration

$XDG_CONFIG_HOME/toe/config.toml
$XDG_CONFIG_HOME/toe/languages.toml

Workspace config goes in .toe/config.toml and .toe/languages.toml at the project root.

Workspace config is trust-gated. See docs/content/docs/configuration.md for details.

:workspace-trust
:workspace-untrust

Development

make pre-commit   # run this before committing
make test
make coverage

Acknowledgements

toe is possible because of excellent terminal UI, parsing, syntax highlighting, and theme projects:

Directories

Path Synopsis
cmd
toe command
internal
lsp
term/builtin/clipboard
Package clipboard provides the yank/paste and register command module
Package clipboard provides the yank/paste and register command module
term/builtin/kit
Package kit holds the shared vocabulary for declaring default command modules: key-sequence builders, signature helpers, option and completion constructors.
Package kit holds the shared vocabulary for declaring default command modules: key-sequence builders, signature helpers, option and completion constructors.
term/builtin/test
Package test is the shared black-box test harness for the default command modules: it builds an editor with all defaults registered and runs commands resolved from the keymaps, so each module's tests can live beside the module while exercising the fully assembled registry
Package test is the shared black-box test harness for the default command modules: it builds an editor with all defaults registered and runs commands resolved from the keymaps, so each module's tests can live beside the module while exercising the fully assembled registry
term/command
Package command defines the command registry types for the editor
Package command defines the command registry types for the editor
term/highlight
Package highlight provides Chroma-based syntax highlighting for the editor It tokenizes document text and maps Chroma token types to terminal styles
Package highlight provides Chroma-based syntax highlighting for the editor It tokenizes document text and maps Chroma token types to terminal styles
term/syntax
Package syntax provides Tree-sitter based syntax highlighting.
Package syntax provides Tree-sitter based syntax highlighting.
term/ui
Package ui implements the Bubbletea terminal application model for toe
Package ui implements the Bubbletea terminal application model for toe
tui
vcs
Package vcs integrates version-control systems with the editor: diff bases for gutter hunks, changed-file listings, and head names.
Package vcs integrates version-control systems with the editor: diff bases for gutter hunks, changed-file listings, and head names.
view/register
Package register implements the editor register store
Package register implements the editor register store

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL