Skip to main content

candat

A terminal IDE with emacs keybindings, built on Textual.

Demo

candat — a full IDE in your terminal

A full IDE in the terminal — split windows on the same file, live markdown preview, a CSV viewer, and a real shell inside.

Install

From PyPI, as a standalone tool (recommended — gives you a global candat command in its own isolated environment):

uv tool install candat
# or, with pipx (needs Python >= 3.10):
pipx install candat

Or with plain pip into the environment of your choice: pip install candat. To try it once without installing anything permanently: uvx candat.

The development version installs straight from GitHub:

uv tool install git+https://github.com/kavonrtep/candat

Requires Python >= 3.10 and Linux.

Run

candat [FILE|DIR ...]

Passing a directory sets the file-tree root; files are opened in buffers.

Keys (so far)

Key Action
C-x C-f find file (opens new file if it doesn't exist)
C-x C-s save buffer
C-x C-w write buffer to another file
C-x C-q toggle read-only (status bar shows %%)
C-x w toggle soft wrap for this buffer
C-x C-r open a file read-only
C-x k kill buffer
C-x b buffer list (Enter switches; next buffer preselected)
C-x o move focus: tree → window(s) → terminal
C-x 3 / C-x 2 split window side-by-side / stacked (same buffer, linked view)
C-x 0 / C-x 1 close this window / the others
C-x C-c quit (confirms if unsaved buffers)
C-x C-x exchange point and mark
C-x h mark whole buffer
C-x u, C-/, C-z undo
C-f C-b C-n C-p C-a C-e char/line movement
M-f M-b word movement
C-v M-v page down / up
M-< M-> beginning / end of buffer
C-space set mark (movement extends region)
C-k kill line (consecutive kills accumulate)
C-w / M-w kill / copy region
C-y / M-y yank / yank-pop
M-d / M-backspace kill word forward / backward
M-up / M-down move current line (or marked block) up / down
C-s / C-r incremental search (smart case, wraps)
M-% query-replace (y/n/!/q)
C-x g project-wide regex search (results list, Enter jumps)
M-; toggle line comment
C-c C-c send region or current line to the terminal REPL
C-x t toggle terminal panel (keys pass through raw; only C-x is reserved)
Shift+PgUp/PgDn terminal scrollback (typing snaps back)
C-c C-v cycle markdown preview: split / preview-only / off
M-x, Ctrl+Shift+P command palette
C-g / Esc cancel chord / prompt / search / mark

ESC acts as the Meta prefix, so ESC w == M-w, ESC x == M-x, etc. Tab completes paths in the find-file and write-file prompts, listing the choices (navigable with arrows, Enter to pick) when more than one matches.

Open files are watched for external changes: clean buffers reload automatically; buffers with local edits ask before discarding them.

Text files over 10 MB open in a less-style pager instead of the editor: the file stays on disk behind a sparse line index (multi-GB files open with bounded memory, with progress shown while indexing), and searches scan in the background so the UI never freezes — C-g cancels one mid-flight. Scroll (keys or mouse wheel), g/G, //? and C-s/C-r search with all visible matches highlighted, C-x w wrap, M-g goto line. F follows a growing file like less +F (rotation-aware; any key stops), and e loads the file into a real editor buffer if you insist. Binary files are shown as a placeholder, and the truncated/binary views refuse to save, so a partial view can never overwrite the real file.

.csv and .tsv files open in a table viewer (inspired by csvlens): a sticky header, row cursor, and original file line numbers in the gutter. Large files stream in as you scroll rather than loading whole. In the table: / (or C-s) searches — literal with smart case, the same dialect as everywhere else — with the matched text highlighted in the cells (Esc clears), n repeats, & filters rows by regex, g/G jump to top/bottom. C-c C-v switches between the table and the raw text. The table is read-only.

The file-tree icons are emoji by default; if your terminal renders them poorly (Konsole, some others), set CANDAT_TREE_ICONS=nerd (needs a Nerd Font) or =ascii, or switch live with M-x cycle-tree-icons — the choice is saved.

Configuration

~/.config/candat/config.toml (XDG aware), all keys optional:

tree_icons = "emoji"     # or "nerd" / "ascii"; cycle-tree-icons saves here
pager_wrap = false       # start the large-file pager with soft wrap on
tabstop = 8              # tab width in the pager
restore_session = true   # reopen last session's files (see below)

Starting candat without file arguments reopens the files you had open the last time you quit in that directory — tabs, cursor positions, scroll, and the active buffer (per project root, kept in ~/.local/state/candat/). Passing files on the command line skips the restore.

Crash logs (including hard faults caught by faulthandler) land in ~/.cache/candat/.

The file tree has a filter box on top: press / while the tree is focused (or click it), type to narrow the tree to files whose path matches, Esc clears it. The file tree opens files on selection. The default theme is candat-light (high-contrast dark-on-white). The markdown preview is linked: it follows the editor's scroll position.

Development

uv run pytest

Release history is in CHANGELOG.md.

Roadmap

  1. Skeleton: tree / tabs / status bar / C-x chords / open & save
  2. Emacs editing: kill ring, C-s/C-r isearch, mark & region, M-x palette
  3. Markdown mode: side-by-side live preview (debounced)
  4. Terminal panel (full PTY: forkpty + pyte)
  5. Polish: terminal scrollback, dirty-line rendering, path completion in prompts, buffer list, scroll-synced preview, R/xml/html highlighting

Syntax highlighting covers python, markdown, json, yaml, bash, html, xml, css, toml, js, sql, go, rust, java, R, and config formats — INI/.cfg/ .conf, Makefiles, Dockerfiles, and shell dotfiles (.bashrc, .env, …).

Metadata

Release files for candat 0.12.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for candat 0.12.0
File Size Uploaded Provenance Actions
candat-0.12.0.tar.gz 56.4 kB Without provenance Details for candat-0.12.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for candat 0.12.0
File Interpreter ABI Platform Actions
candat-0.12.0-py3-none-any.whl Python 3 none any Details for candat-0.12.0-py3-none-any.whl

Total release size: 123.8 kB

Release files / candat-0.12.0.tar.gz

Download URL candat-0.12.0.tar.gz
Size 56.4 kB
Tags Source
SHA-256 checksum
How to use checksums
25ffbfc382004662cc28ec16260e2ef6faf1046196198c60b404ff775120f6ce
BLAKE2b-256 checksum
How to use checksums
53f38a4bee8950f10d9aa25a21c642341efa60b30dad42d3cd2198422101dfd1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / candat-0.12.0-py3-none-any.whl

Download URL candat-0.12.0-py3-none-any.whl
Size 67.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
482514b1ebedc413378a94b6d9402bf3ab9edeb36c74717983ff8fbe143b64e4
BLAKE2b-256 checksum
How to use checksums
564181ca2016982ec2902d3f6ae73fd2b2630470c68cf95e60a59d8078d62a65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for candat 0.12.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page