todoke 0.1.0

A rule-driven file dispatcher: hands incoming file paths to the right editor or script based on TOML-defined rules.
todoke-0.1.0 is not a library.

todoke

┌──────┐       ┌────────┐       ╭──▶ nvim
│ file │ ──▶   │ todoke │ ──▶   ├──▶ code
└──────┘       └────────┘       ╰──▶ script / …

todoke takes one or more file paths and decides what to do with each of them — by regex-matching the path against a TOML ruleset. A rule can target a long-running neovim (reused via msgpack-RPC), any generic CLI editor, or a raw shell script. Perfect as your OS default program for text files, as $EDITOR, or as a standalone file handler.

It is the successor to edtr / hitori.vim, generalized from "editor router" into a full rule-driven dispatcher.

Features

  • Rule-based routing: regex patterns in TOML decide what handles each file. Different paths → different handlers (VSCode for one project, nvim for another, a shell script for a third).
  • Single-instance neovim via named pipes / unix sockets: todoke connects to a running nvim and sends :edit over msgpack-RPC. Works on Windows via \\.\pipe\... — no Deno, no plugin framework, no cold start.
  • Sync or async per rule: sync = true blocks until the handler exits (perfect for git commit), sync = false fires and forgets (perfect for double-clicking files in the OS file explorer).
  • Tera templating throughout the config: {{ file_path }}, {{ env.HOME }}, {% if is_windows() %}…{% endif %}, structural conditionals that include whole editor / rule blocks, every Tera filter.
  • Generic CLI support: any command-line tool works (code, vim, helix, subl, emacsclient, bat, pandoc, …) without custom code.
  • edtr compatibility: same embedded default config, same config schema. Existing edtr users migrate by renaming the config directory (see below).
  • Fast: static Rust binary, cold start in milliseconds. On Windows this is often 10–100× faster than denops-based alternatives.

Install

cargo install todoke

Binary lives at ~/.cargo/bin/todoke. Make sure that's on your PATH.

Quick start

todoke works out of the box with a bundled default config — it routes everything to a single shared neovim instance, except $EDITOR-callback files (COMMIT_EDITMSG etc.) which always get a fresh sync = true instance so git commit works.

To customize, drop a file at:

  • Linux / macOS / Windows: ~/.config/todoke/todoke.toml

Minimal example:

# ~/.config/todoke/todoke.toml

[editors.nvim]
kind = "neovim"
command = "nvim"
listen = '{% if is_windows() %}\\.\pipe\nvim-todoke-{{ group }}{% else %}/tmp/nvim-todoke-{{ group }}.sock{% endif %}'

[editors.code]
kind = "generic"
command = "code"
args_remote = ["--reuse-window"]
args_new = ["--new-window"]

# git commit, rebase, etc. — always a blocking fresh nvim.
[[rules]]
name = "editor-callback"
match = '(?i)/(COMMIT_EDITMSG|MERGE_MSG|git-rebase-todo)$'
editor = "nvim"
mode = "new"
sync = true

# Route files under ~/src/company/ to VSCode.
[[rules]]
name = "work"
match = '/src/company/'
editor = "code"
mode = "remote"

# Default: everything else goes to the shared nvim.
[[rules]]
name = "default"
match = '.*'
editor = "nvim"
group = "default"
mode = "remote"

Then:

# Open any file in the right handler
todoke notes.md

# See which rule would match, without actually dispatching
todoke check notes.md src/main.rs

# Same dispatch logic, don't execute
todoke --dry-run notes.md

# Lint the config for common footguns
todoke doctor

As $EDITOR

export EDITOR=todoke
git commit      # → todoke routes COMMIT_EDITMSG to nvim mode=new sync=true

The bundled default config is compatible with every $EDITOR=… caller I know of (git, crontab, visudo, fc, mutt, …).

As OS default program (Windows)

Right-click a .txt → Open with → Choose another app → Browse → point at todoke.exe. todoke honors the rules and opens the file in the correct handler, spawning a new console if the target is a TUI.

Migrating from edtr

# Linux / macOS
mv ~/.config/edtr ~/.config/todoke
mv ~/.config/todoke/edtr.toml ~/.config/todoke/todoke.toml

# Update env var if you set it
export EDITOR=todoke

# If the config mentions the pipe name, change `nvim-edtr-` → `nvim-todoke-`

TODOKE_CONFIG replaces EDTR_CONFIG as the env override.

Configuration reference

[vars]

User-defined variables available as {{ vars.NAME }} in every other template:

[vars]
proj_root = "/home/me/src"

[editors.<name>]

field type required meaning
kind "neovim" / "generic" yes backend selection
command string yes the handler binary (PATH-resolved)
listen string neovim socket / named pipe path for RPC
args_new array<string> no extra args when mode = "new"
args_remote array<string> no extra args when spawning for mode = "remote" fallback
env table no env vars passed to the spawned handler

[[rules]]

field type default meaning
name string rule[N] human-readable label (shown in check)
match regex string or [regex] required path pattern(s); paths are normalized to / before matching
exclude regex string or [regex] none when any exclude hits, the rule is skipped even if match hits — todoke falls through to the next rule
editor string required key from [editors.*]
group string "default" instance identity (one nvim per group)
mode "remote" / "new" "remote" remote = reuse existing, new = always fresh
sync bool false true = block until handler exits

Template context

Available in rule.group, rule.editor, editor.command, editor.listen, editor.args_*:

variable example
file_path C:/Users/you/notes/todo.md
file_dir C:/Users/you/notes
file_name todo.md
file_stem todo
file_ext md (no leading dot)
editor_* same five fields for command
cwd current working directory
group resolved group (phase 3 only)
rule resolved rule name (phase 3)
vars.<key> your [vars] entries
env.<KEY> process env at todoke invocation

And these todoke-specific Tera functions:

  • is_windows(), is_linux(), is_mac() — booleans for OS branching.

Plus everything Tera ships — replace, split, join, length, now(), structural {% if %} / {% elif %} / {% else %} blocks around editor and rule sections, and all other stock Tera features.

CLI reference

todoke [FILES]...            # dispatch files per rules (default action)
todoke check <FILES>...      # dry-run: show matched rule per file
todoke doctor                # lint the config for common footguns
todoke completion <shell>    # emit shell completion script
todoke --help
todoke --version

# v0.2+:
todoke list                    # list alive handler instances
todoke kill <group> | --all    # terminate instances
todoke config path | edit | validate | show

Flags:

  • -c, --config <PATH> — override config path
  • -E, --editor <NAME> — bypass rule, force handler
  • -G, --group <NAME> — bypass rule, force group
  • --dry-run — print the resolved plan without executing
  • -v, --verbose-v = info, -vv = debug, -vvv = trace

Logging is also controllable via RUST_LOG.

Roadmap

  • v0.1 (this release): core dispatch, neovim + generic backends, check, doctor, completion, default config, $EDITOR compatibility, colored output.
  • v0.2: list / kill / config edit|validate|show, open / send, neovim remote + sync via nvim_buf_attach.
  • v0.3: script editor kind — run arbitrary shell commands as a handler, turning todoke into a general "open with rules" tool for any file type (previewer, formatter, pipeline, …).

Heritage

todoke extends edtr, which was itself a Rust rewrite of hitori.vim. The lineage:

  • hitori.vim (denops): single-instance vim plugin, vim/neovim-only, slow on Windows.
  • edtr: Rust rewrite, editor-agnostic, fast on all platforms.
  • todoke: edtr plus broader scope — any command-line handler (not just editors), any file type. The name 「届け」 means deliver in Japanese.

License

MIT — © 2026 yukimemi.