Skip to main content

Terminal-based text editor with mouse-driven toolbar actions.

Project description

Qudix

Qudix is a lightweight terminal-based text editor that brings a modern editing experience to your command line. With mouse support, intuitive toolbar buttons, and familiar keyboard shortcuts, it makes text editing in the terminal feel natural and efficient. Derived from the highlighted letters in “[Qu]ick e[di]t ne[x]t.”

Features

Core Editing

  • Undo/Redo – Full undo and redo support to easily revert or reapply changes
  • Cut/Copy/Paste – Standard clipboard operations that work with your system clipboard
  • Delete – Quick deletion of selected text or current line
  • Mouse Selection – Click and drag to select text across lines, just like a GUI editor
  • Keyboard Selection – Automatic line selection when no text is selected for quick operations

User Interface

  • Interactive Toolbar – Clickable buttons for common editing actions at the top of the screen
  • Line Numbers – Built-in line numbers for easy navigation
  • Scrollbar – Visual scrollbar for large files
  • Status Bar – Shows current file path, save status, and action feedback
  • File Creation Dialog – Convenient popup window to create new files when launched without a path

System Integration

  • Cross-Platform Clipboard – Seamless integration with macOS, Windows, and Linux system clipboards
  • File Operations – Save with Ctrl+S and track unsaved changes automatically
  • Unsaved Changes Warning – Prevents accidental data loss by prompting before exit

Installation

Recommended: install with pipx to avoid interfering with system packages.

macOS

brew install pipx
pipx ensurepath
pipx install qudix

Linux

  • Ubuntu 23.04+:
sudo apt update
sudo apt install pipx
pipx ensurepath
pipx install qudix
  • Fedora:
sudo dnf install pipx
pipx ensurepath
pipx install qudix
  • Arch Linux:
sudo pacman -S python-pipx
pipx ensurepath
pipx install qudix
  • Other distros (via pip user install):
python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install qudix

Windows

  • With Scoop:
scoop install pipx
pipx ensurepath
pipx install qudix
  • With Python/pip:
py -m pip install --user pipx
# Then open a new terminal or run:
.\pipx.exe ensurepath
pipx install qudix

Usage

Launch the editor in two ways:

Create a new file (popup dialog will appear):

qudix

Open an existing file or create one at a specific path:

qudix /path/to/file/filename.txt

Keyboard Shortcuts

Shortcut Action
Ctrl+S Save file
Ctrl+X Exit editor (prompts if unsaved)
Esc Return focus to text area
Ctrl+Home Jump to top of file
Backspace Delete character or selection

Mouse Controls:

  • Click anywhere to position cursor
  • Click and drag to select text
  • Click toolbar buttons to perform actions
  • Scroll wheel to navigate through file

Build Instructions

If you want to build from source:

# Clone the repository
git clone <repository-url>
cd qudix

# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install in editable mode
pip install -e .

Development

The project uses a standard src/ layout with the main application code in src/qudix/app.py. It's built on top of prompt_toolkit, which provides the terminal UI framework.

Project Structure

src/qudix/
  ├── __init__.py
  └── app.py         # Main application entry point

License

This project is dual-licensed under Apache-2.0 OR MIT. You may use it under the terms of either license at your option. See LICENSE, LICENSE-APACHE, and LICENSE-MIT for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qudix-0.1.5.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qudix-0.1.5-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file qudix-0.1.5.tar.gz.

File metadata

  • Download URL: qudix-0.1.5.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for qudix-0.1.5.tar.gz
Algorithm Hash digest
SHA256 d636c7a355992b7f8bc6b1aeade16c49ad3938b8dbe21d9b037c0a8372b3fe81
MD5 0d443c9046b3243145b5b7559d302159
BLAKE2b-256 1523cd7889286623478d5449324edd89e4cfe0fdd67fdeae16ec3fedc481efe4

See more details on using hashes here.

File details

Details for the file qudix-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: qudix-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for qudix-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fe5002039b3b24e5ba7567c1398b6ab99c8c00923d02f82086a3e017727f5a98
MD5 ac0c958fe65d4c58bf72d241e1a7658d
BLAKE2b-256 757a121d8df0189d4e3ebd3ce5415f6b70c37e708ee59cb6f04cf9d018cfc59e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page