A sleek, powerful terminal text editor built with Textual
Project description
Axiom TUI
A terminal text editor that doesn't make you feel lame.
I have an ubuntu server on my rpi5 running in my room and I kept needing to edit files on it. Nano works but it looks like it's from the 90s. I tried vim but it wasn't satisfactory using it, So I thought why not make an usable, modern tui text editor for fun? I was out of ideas and I had a weekend to spare. So I built this.
It's not trying to replace anything. It's just a small editor you can open from the terminal when you need to make a quick edit and you want it to not look terrible.
Install
You need Python 3.11+
Recommended - install from PyPI:
pip install axiom-tui
That's it. Now you can open files from anywhere:
axiom main.py
axiom ~/.bashrc
axiom . # Opens the current folder directly
Want to build it yourself? Clone and install in editable mode:
git clone https://github.com/adyanthm/axiom-tui.git
cd axiom-tui
pip install -e .
This way you get the axiom command and any changes you make to the source take effect immediately.
Don't have Python?
Grab axiom.exe (or the Linux/Mac binary) from the releases page. No Python needed, everything is bundled inside.
To use it as a global command (so you can just type axiom file.py from anywhere):
Windows:
- Download
axiom.exe - Put it somewhere like
C:\tools\ - Add that folder to your PATH (search "environment variables" in Start, edit the
Pathvariable, addC:\tools\) - Open a new terminal and you're good to go
Linux:
chmod +x axiom-linux
sudo mv axiom-linux /usr/local/bin/axiom
Mac:
chmod +x axiom-macos
sudo mv axiom-macos /usr/local/bin/axiom
After that, just use it like any other command:
axiom server.py
axiom ~/.bashrc
axiom config.yml
axiom /var/log/ # Opens a folder instead of a file
What it does
- Multi-Tab Support - Open multiple files at once. They'll show up as tabs at the top. Close them with
ctrl+w. - Quick File Creation - Hit
ctrl+nto pull up a floating box. Type a name to create a file, or add a/at the end to create a folder. - Syntax highlighting for Python, JS, TS, Rust, Go, C, Java, Ruby, and a bunch more.
- Autocomplete (LSP) for an IDE-like experience right in the terminal.
- File tree on the left so you can browse around without leaving the editor. Pass a folder (
axiom .) to open straight into the tree. - Active file indicator right in the top header.
- Search that actually jumps to the match.
- Line numbers and a status bar with cursor position.
- Unsaved changes indicator (little dot next to the filename).
- Theme sync - When you switch app themes the syntax colors follow along. The default is
textual-dark, but I also added a sleek customaxiom-protheme!
Keybinds
| Key | Does |
|---|---|
ctrl+s |
Save |
ctrl+n |
Create new file or folder |
ctrl+w |
Close current tab |
ctrl+f |
Search (Enter to find, Esc to close) |
ctrl+b |
Toggle file tree |
ctrl+q |
Quit |
You can also switch themes through Textual's command palette.
Autocomplete (LSP)
I added Language Server Protocol (LSP) support so you get live, IDE-like autocomplete dropdowns as you type. Navigate with Up/Down and accept with Tab
Because language servers are huge, I didn't bundle them all by default. It's smart enough to just degrade gracefully to a normal editor if you don't have the server installed.
For Python:
Just install the editor with the [lsp] extra and you're good to go:
pip install axiom-tui[lsp]
(This just installs python-lsp-server alongside the editor).
For other languages: It works for other languages too, you just need to have their respective language servers installed on your system. Axiom will automatically find them and connect.
- JS/TS: needs
typescript-language-server - Rust: needs
rust-analyzer - Go: needs
gopls - C / C++: needs
clangd
The Theme Thing
So here's a fun rabbit hole I fell into: Textual has app themes (like Dracula, Nord, Catppuccin etc) and the TextArea widget has its own completely separate syntax highlighting themes. When you switch the app theme, only the UI chrome changes - the actual code highlighting stays the same.
I fixed this by mapping each app theme to the closest syntax theme. It's not perfect but it works. If you switch to Dracula the syntax goes Dracula, if you pick something light it switches to GitHub Light, etc.
Stuff I might add
- Find and replace (right now it's just find)
- Remember last open file
- Goto line number
No promises though. This is a weekend project that I use for myself. If it helps you too, cool.
Contributing
PRs are welcome. Just keep it simple - the whole point is that this is a small, clean codebase. If your feature doubles the line count, maybe it should be a fork instead.
License
MIT. Do whatever you want with it.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file axiom_tui-1.1.1.tar.gz.
File metadata
- Download URL: axiom_tui-1.1.1.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
979dc384d8f0abeae41f3a90a589ff693120a435d78549fe7e116023d0dd77c1
|
|
| MD5 |
ceeb1c8bb527a51592d5ea1c586c52d1
|
|
| BLAKE2b-256 |
e48617ccfdb413517f66417f2ab873a5d182fc5d199943e5a0c9c7c850752175
|
Provenance
The following attestation bundles were made for axiom_tui-1.1.1.tar.gz:
Publisher:
release.yml on adyanthm/axiom-tui
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
axiom_tui-1.1.1.tar.gz -
Subject digest:
979dc384d8f0abeae41f3a90a589ff693120a435d78549fe7e116023d0dd77c1 - Sigstore transparency entry: 1437229616
- Sigstore integration time:
-
Permalink:
adyanthm/axiom-tui@10af518bc724670180ad198ad86ed616cde75a77 -
Branch / Tag:
refs/tags/v1.1.1 - Owner: https://github.com/adyanthm
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@10af518bc724670180ad198ad86ed616cde75a77 -
Trigger Event:
push
-
Statement type:
File details
Details for the file axiom_tui-1.1.1-py3-none-any.whl.
File metadata
- Download URL: axiom_tui-1.1.1-py3-none-any.whl
- Upload date:
- Size: 11.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f844fc7ed0a54f1f9973bd07415660da5efd81a49b3dc03af7ca9be1dcc65ded
|
|
| MD5 |
44262cd097ad5fc9bbacd01d22504516
|
|
| BLAKE2b-256 |
852b752c6406105a912e91ef52ee25a03edbe5566a034618c3044115454b54c3
|
Provenance
The following attestation bundles were made for axiom_tui-1.1.1-py3-none-any.whl:
Publisher:
release.yml on adyanthm/axiom-tui
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
axiom_tui-1.1.1-py3-none-any.whl -
Subject digest:
f844fc7ed0a54f1f9973bd07415660da5efd81a49b3dc03af7ca9be1dcc65ded - Sigstore transparency entry: 1437229635
- Sigstore integration time:
-
Permalink:
adyanthm/axiom-tui@10af518bc724670180ad198ad86ed616cde75a77 -
Branch / Tag:
refs/tags/v1.1.1 - Owner: https://github.com/adyanthm
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@10af518bc724670180ad198ad86ed616cde75a77 -
Trigger Event:
push
-
Statement type: