textual-code 0.0.2__tar.gz → 0.1.1__tar.gz

textual_code-0.1.1/.devcontainer/Dockerfile

@@ -0,0 +1,85 @@
+FROM ubuntu:24.04 AS base
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# install basic packages
+RUN apt-get update && apt-get upgrade -y && apt-get install -y --fix-broken && apt-get install -y --no-install-recommends \
+    build-essential \
+    ca-certificates \
+    curl \
+    git \
+    locales \
+    ssh \
+    sudo \
+    vim \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+RUN locale-gen en_US.UTF-8
+
+ARG USER_UID=1000
+ARG USER_GID=1000
+
+RUN (groupadd --gid $USER_GID appuser || true) \
+    && (useradd --uid $USER_UID --gid $USER_GID -m appuser -s /bin/bash || true) \
+    && export USERNAME=$(getent passwd $USER_UID | cut -d: -f1) \
+    && echo "$USERNAME ALL=(root) NOPASSWD:ALL" > /etc/sudoers.d/$USERNAME \
+    && chmod 0440 /etc/sudoers.d/$USERNAME
+
+RUN mkdir -p /project \
+    && chown $USER_UID:$USER_GID /project
+
+# set LANG env variable
+USER $USER_UID
+RUN echo 'export LANG="en_US.UTF-8"' >> ~/.bashrc \
+    && echo 'export LC_ALL="en_US.UTF-8"' >> ~/.bashrc \
+    && echo 'export NODE_LLAMA_CPP_CMAKE_OPTION_GGML_CUDA=OFF' >> ~/.bashrc
+
+FROM base AS tools
+
+# install lazygit
+USER root
+RUN export LAZYGIT_VERSION=$(curl -s "https://api.github.com/repos/jesseduffield/lazygit/releases/latest" | \grep -Po '"tag_name": *"v\K[^"]*') \
+    && export ARCH=$(dpkg --print-architecture) \
+    && if [ "$ARCH" = "amd64" ]; then export LAZYGIT_ARCH="x86_64"; elif [ "$ARCH" = "arm64" ]; then export LAZYGIT_ARCH="arm64"; else export LAZYGIT_ARCH="$ARCH"; fi \
+    && curl -Lo lazygit.tar.gz "https://github.com/jesseduffield/lazygit/releases/download/v${LAZYGIT_VERSION}/lazygit_${LAZYGIT_VERSION}_Linux_${LAZYGIT_ARCH}.tar.gz" \
+    && tar xf lazygit.tar.gz lazygit \
+    && install lazygit -D -t /usr/local/bin/ \
+    && rm -rf lazygit.tar.gz lazygit
+
+FROM tools AS dev
+
+### PROJECT-SPECIFIC SETUP BEGIN
+
+# install dependencies
+USER root
+# shellcheck is for linting shell scripts
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    shellcheck \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# install uv
+USER $USER_UID
+COPY --from=ghcr.io/astral-sh/uv:0.10.2 /uv /uvx /bin/
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+ENV UV_CACHE_DIR=/project/.devcontainer/uv/cache
+ENV UV_PYTHON_INSTALL_DIR=/project/.devcontainer/uv/python
+ENV UV_PYTHON_BIN_DIR=/project/.devcontainer/uv/python-bin
+
+# install python using uv
+USER $USER_UID
+RUN uv python install 3.12 --default \
+    && echo 'export PATH="/project/.devcontainer/uv/python-bin:$PATH"' >> ~/.bashrc \
+    && export PATH="/project/.devcontainer/uv/python-bin:$PATH"
+
+# set TERM and COLORTERM env variable for correct color rendering in textual
+USER $USER_UID
+RUN echo 'export TERM="xterm-256color"' >> ~/.bashrc \
+    && echo 'export COLORTERM="truecolor"' >> ~/.bashrc \
+    && export TERM="xterm-256color" \
+    && export COLORTERM="truecolor"
+
+### PROJECT-SPECIFIC SETUP END
+
+USER $USER_UID
+WORKDIR /project

textual_code-0.1.1/.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+{
+    "name": "textual-code-devcontainer",
+    "dockerComposeFile": "docker-compose.yml",
+    "service": "textual-code-devcontainer-app",
+    "workspaceFolder": "/project",
+    "remoteUser": "1000", // uid of the user in the container, typically a non-root user
+    "postCreateCommand": "/project/.devcontainer/ensure-ai-symlinks.sh",
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "window.autoDetectColorScheme": true,
+                "workbench.preferredDarkColorTheme": "One Dark Pro",
+                "workbench.preferredLightColorTheme": "Visual Studio Light"
+            },
+            "extensions": [
+                "Anthropic.claude-code",
+                "astral-sh.ty",
+                "charliermarsh.ruff",
+                "GitHub.copilot",
+                "mhutchie.git-graph",
+                "ms-python.python",
+                "Textualize.textual-syntax-highlighter"
+            ]
+        }
+    }
+}

textual_code-0.1.1/.devcontainer/docker-compose.yml

@@ -0,0 +1,23 @@
+name: textual-code-devcontainer
+
+services:
+  textual-code-devcontainer-app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    restart: "no"
+    command: sleep infinity
+    init: true
+    volumes:
+      - ../:/project
+    environment:
+      - CLAUDE_CONFIG_DIR=/home/appuser/.claude
+    env_file:
+      - path: ../.env
+        required: false
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10m"
+        max-file: "100"
+        compress: "true"

textual_code-0.1.1/.devcontainer/ensure-ai-symlinks.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+# Ensure AI tool directories and files exist in devcontainer
+# This script is called during devcontainer post-create phase
+
+set -eu
+
+# Define base paths
+DEVCONTAINER_DIR="/project/.devcontainer"
+HOME_DIR="/home/$(whoami)"
+
+# Create directories if they don't exist
+mkdir -p "${DEVCONTAINER_DIR}/.claude"
+mkdir -p "${DEVCONTAINER_DIR}/qmd-config"
+mkdir -p "${DEVCONTAINER_DIR}/qmd-cache"
+
+# Create files if they don't exist
+if [ ! -f "${DEVCONTAINER_DIR}/.claude.json" ]; then
+    echo "{}" > "${DEVCONTAINER_DIR}/.claude.json"
+fi
+if [ ! -f "${DEVCONTAINER_DIR}/.claude.json.backup" ]; then
+    echo "{}" > "${DEVCONTAINER_DIR}/.claude.json.backup"
+fi
+
+# Ensure proper ownership
+chown -R $(whoami):$(whoami) "${DEVCONTAINER_DIR}/.claude"
+chown -R $(whoami):$(whoami) "${DEVCONTAINER_DIR}/qmd-config"
+chown -R $(whoami):$(whoami) "${DEVCONTAINER_DIR}/qmd-cache"
+chown $(whoami):$(whoami) "${DEVCONTAINER_DIR}/.claude.json"
+chown $(whoami):$(whoami) "${DEVCONTAINER_DIR}/.claude.json.backup"
+
+# Create symlinks if they don't exist
+if [ ! -L "${HOME_DIR}/.claude" ]; then
+    ln -sf "${DEVCONTAINER_DIR}/.claude" "${HOME_DIR}/"
+fi
+
+if [ ! -L "${HOME_DIR}/.config/qmd" ]; then
+    ln -sf "${DEVCONTAINER_DIR}/qmd-config" "${HOME_DIR}/.config/qmd"
+fi
+
+if [ ! -L "${HOME_DIR}/.cache/qmd" ]; then
+    ln -sf "${DEVCONTAINER_DIR}/qmd-cache" "${HOME_DIR}/.cache/qmd"
+fi
+    
+if [ ! -L "${HOME_DIR}/.claude.json" ]; then
+    ln -sf "${DEVCONTAINER_DIR}/.claude.json" "${HOME_DIR}/.claude.json"
+fi
+
+if [ ! -L "${HOME_DIR}/.claude.json.backup" ]; then
+    ln -sf "${DEVCONTAINER_DIR}/.claude.json.backup" "${HOME_DIR}/.claude.json.backup"
+fi

textual_code-0.1.1/.devcontainer/qmd-config/index.yml

@@ -0,0 +1,7 @@
+collections:
+  docs:
+    path: /project/docs
+    pattern: "**/*.md"
+  root:
+    path: /project
+    pattern: "*.md"

textual_code-0.1.1/.dockerignore

@@ -0,0 +1,34 @@
+# devcontainer
+!.devcontainer/.claude
+.devcontainer/.claude/*
+.devcontainer/.claude.json
+.devcontainer/.claude.json.backup
+.devcontainer/qmd-cache/
+.devcontainer/data
+.devcontainer/uv
+.devcontainer/local
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+
+# claude
+.claude/settings.local.json
+CLAUDE.local.md
+
+# Test artifacts
+snapshot_report.html
+
+# Environment
+.env
+.env.local
+
+# Downloaded library docs
+docs/libs/
+
+# --- gitignore end ---
+
+dist/
+.devcontainer/qmd-config/

textual_code-0.1.1/.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+# end_of_line = lf
+
+[*.py]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+charset = utf-8
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8

textual_code-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  push:
+    tags:
+      # Publish on any tag starting with a `v`, e.g. v1.2.3
+      - v*
+
+jobs:
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+      - run: uv build
+      - run: uv publish --trusted-publishing always
+
+  github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Extract changelog for this version
+        id: changelog
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          # Extract the section for this version from CHANGELOG.md
+          body=$(awk -v ver="$version" '
+            /^## \[/ {
+              if (found) exit
+              if (index($0, "[" ver "]")) found=1
+              next
+            }
+            found { print }
+          ' CHANGELOG.md)
+          # Write to file to preserve newlines
+          echo "$body" > release_body.md
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: release_body.md
+          generate_release_notes: false

textual_code-0.1.1/.gitignore

@@ -0,0 +1,29 @@
+# devcontainer
+!.devcontainer/.claude
+.devcontainer/.claude/*
+.devcontainer/.claude.json
+.devcontainer/.claude.json.backup
+.devcontainer/qmd-cache/
+.devcontainer/data
+.devcontainer/uv
+.devcontainer/local
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+
+# claude
+.claude/
+CLAUDE.local.md
+
+# Test artifacts
+snapshot_report.html
+
+# Environment
+.env
+.env.local
+
+# Downloaded library docs
+docs/libs/

{textual_code-0.0.2 → textual_code-0.1.1}/.pre-commit-config.yaml

@@ -6,8 +6,10 @@ repos:
         entry: ruff check --force-exclude --fix
         language: python
         types_or: [python, pyi, jupyter]
+        additional_dependencies: [ruff]
       - id: ruff-format
         name: ruff format
         entry: ruff format --force-exclude
         language: python
         types_or: [python, pyi, jupyter]
+        additional_dependencies: [ruff]

textual_code-0.1.1/.textual-code.toml

@@ -0,0 +1,6 @@
+[editor]
+indent_type = "spaces"
+indent_size = 4
+line_ending = "lf"
+encoding = "utf-8"
+word_wrap = true

textual_code-0.1.1/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] - 2026-03-18
+
+### Fixed
+
+- Wheel build only included `.scm` grammar files, excluding all Python source — caused `ModuleNotFoundError` when installed via `pip install` or `uv tool install`
+
+## [0.1.0] - 2026-03-18
+
+### Added
+
+- **Editor**: multiple cursors with Ctrl+Alt+Up/Down, add next occurrence (Ctrl+D), select all occurrences (Ctrl+Shift+L); multi-cursor movement, selection, typing, and editing all work simultaneously; move line up/down (Alt+Up/Down), scroll viewport (Ctrl+Up/Down), select all (Ctrl+A), double/triple click word/line selection, Ctrl+C/X copies/cuts current line when no selection, Tab/Shift+Tab indent/dedent, Ctrl+Shift+Z redo
+- **Find & Replace**: inline find/replace bar (Ctrl+F/Ctrl+H) with regex, case-sensitivity, and Select All matches for multi-cursor editing; workspace-wide search (Ctrl+Shift+F) and Replace All with gitignore, file include/exclude filters, case-sensitivity toggle, and background search with loading indicator
+- **Split view**: unlimited nested horizontal/vertical splits via recursive tree structure; split in any direction (Ctrl+\\, command palette); close split (Ctrl+Shift+\\); drag-and-drop tabs between splits with 4-direction edge zones and visual drop hints; drag resize handles; toggle split orientation; directional tab move commands; move tab to other split (Ctrl+Alt+\\); live text sync between split editors viewing the same file; focus cycling with F6/Shift+F6
+- **Explorer**: create file/directory (Ctrl+N/Ctrl+D in sidebar), delete file/folder (Delete key); toggle hidden files, dim gitignored files, dim hidden files, git status highlighting (modified in yellow, untracked in green with folder inheritance); auto-refresh on workspace file changes and git status changes; cursor sync with active editor tab; responsive emoji icons that collapse at narrow widths
+- **File handling**: new file (Ctrl+N), Save As, reload file from disk; expanded encoding auto-detection (40+ encodings including CJK via charset-normalizer); binary file detection; EditorConfig support with auto-reload on `.editorconfig` changes; `trim_trailing_whitespace` and `insert_final_newline` applied at save time; configurable line endings; free-form indentation size input; external file change detection with auto-reload or overwrite confirmation
+- **Tabs & navigation**: command palette (Ctrl+Shift+P) for quick access to all commands; tab reorder by drag, cross-split tab drag, Goto Line (Ctrl+G), copy relative/absolute path, close all (Ctrl+Shift+W), save all (Ctrl+Shift+S), toggle sidebar (Ctrl+B), sidebar drag resize, resize sidebar/split via command palette
+- **Markdown**: live preview in tab (Ctrl+Shift+M) with debounced auto-updates, GFM support, keyboard scrolling; preview closes with source editor
+- **Themes**: UI theme selection from 20 built-in themes (nord, gruvbox, dracula, etc.); syntax highlighting theme selection (monokai, dracula, github_light, vscode_dark, css)
+- **Keyboard shortcuts**: view and customize all key bindings (F1), shortcut hints in command palette, custom bindings saved to keybindings.toml
+- **Configuration**: user-level and project-level settings persistence (TOML) with project taking priority; open settings commands; save-level selector (User/Project) in theme and default settings dialogs; `sidebar_width`, `path_display_mode`, `warn_line_ending`, word wrap toggle and default settings; `--workspace` / `-w` CLI option for overriding sidebar root directory
+- **Language support**: syntax highlighting for 10 additional languages (TypeScript, TSX, C, C++, Ruby, Kotlin, Lua, PHP, Dockerfile, Makefile) via tree-sitter-language-pack; extended file type detection for dotfiles and additional extensions
+- **Footer**: clickable file path copies to clipboard; path display mode toggle (absolute/relative); cursor position with multi-cursor count; clickable language, encoding, line ending, and indentation indicators; dynamic column sizing
+
+### Changed
+
+- Default word wrap changed to enabled
+- Footer path truncation indicator visually distinct from actual path characters
+
+## [0.0.2] - 2025-01-07
+
+### Added
+
+- Add basic text editing features
+
+[unreleased]: https://github.com/rishubil/textual-code/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/rishubil/textual-code/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/rishubil/textual-code/compare/v0.0.2...v0.1.0
+[0.0.2]: https://github.com/rishubil/textual-code/releases/tag/v0.0.2

textual_code-0.1.1/CLAUDE.md

@@ -0,0 +1,56 @@
+# Agent Instructions
+
+**CRITICAL RULES:**
+- Put the truth and the correct answer above all else. Feel free to criticize user's opinion, and do not use false empathy with the user. Keep a dry and realistic perspective.
+- Use qmd to check documentation on every task to maintain consistency
+- **Always run Python with `uv`**: never call `python` or `pip` directly; always use `uv run python`, `uv run pytest`, `uv run ruff`, etc.
+- **Avoid `$()` in Bash tool calls**: `$()` command substitution triggers extra user confirmation in Claude Code. Split into separate Bash tool calls instead:
+  ```
+  # BAD — single Bash call with nested $() requires extra confirmation
+  uv run pytest tests/ -n $(( $(nproc) * 2 )) -m "not serial"
+
+  # GOOD — two separate Bash tool calls
+  Call 1: nproc          → returns e.g. "4"
+  Call 2: uv run pytest tests/ -n 8 -m "not serial"
+  ```
+  Read the output of the first call and substitute the value directly into the second call.
+- Use WebFetch proactively. Always check the latest development docs and search for anything unclear.
+- All code comments, docstrings, and documentation (including files in `docs/`) must be written in **English**.
+
+## Test Strategy: Red-Green TDD
+
+> See `docs/testing-guide.md` for test patterns, best practices, and gotchas (`make_app(light=True)`, `pilot.pause()` rules, snapshot conventions, etc.)
+
+**Before starting work, check and run existing tests:**
+
+1. **Find test files**: use Glob/Grep to find test files related to the code you are modifying
+2. **Run existing tests**: run tests before starting work to understand the current state (pass/fail)
+3. **Establish a baseline**: know which tests pass before your changes so you can detect regressions
+
+**Apply Red-Green TDD to modification tasks:**
+
+- **Red**: first write or identify a test that verifies the behaviour to be changed (failing state)
+- **Green**: implement the minimum code needed to make the test pass
+- **Verify**: confirm that all pre-existing tests still pass
+
+**When modifying code with no tests:**
+- Add tests before modifying if possible
+- If adding tests is out of scope, state it explicitly: "This change has no tests"
+
+**When adding new UI (modal / widget / screen):**
+- A snapshot test is **mandatory**. Add it to `tests/test_snapshots.py` before the implementation is merged.
+- Use `_open_editor_modal` helper for editor-triggered modals; use `_open_app_modal` for app-level modals.
+- Run `uv run pytest tests/test_snapshots.py --snapshot-update` after adding the test to generate the SVG.
+
+## Textual Official Documentation
+
+When Textual framework behaviour (API, Widget, Screen, Worker, reactive, etc.) is uncertain, **always search the local docs before implementing**.
+
+- **Local docs**: `docs/libs/textual/` (MkDocs format, mirrored from textual.textualize.io)
+- Key topics: App · ModalScreen · push_screen · dismiss · Message · on_* · reactive · watch_* · Worker · @work · BINDINGS · Binding · action_* · CommandPalette · Provider · TCSS · TabbedContent · TabPane · DirectoryTree · TextArea
+
+**No guessing**: if behaviour is unclear, search the local docs first.
+
+---
+
+See @README.md for project overview

textual_code-0.1.1/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: textual-code
+Version: 0.1.1
+Summary: Code editor for who don't know how to use vi
+Project-URL: Repository, https://github.com/rishubil/textual-code.git
+Project-URL: Changelog, https://github.com/rishubil/textual-code/blob/master/CHANGELOG.md
+Author-email: Nesswit <rishubil@gmail.com>
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: Microsoft :: Windows :: Windows 11
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Editors
+Requires-Python: >=3.12
+Requires-Dist: charset-normalizer>=3.0.0
+Requires-Dist: pathspec>=1.0.4
+Requires-Dist: textual[syntax]>=1.0.0
+Requires-Dist: tree-sitter-language-pack>=0.13.0
+Requires-Dist: typer>=0.15.1
+Description-Content-Type: text/markdown
+
+# Textual Code
+
+Code editor for who don't know how to use vi
+
+![Screenshot](tests/__snapshots__/test_snapshots/test_snapshot_readme_preview.svg)
+
+> [!WARNING]  
+> This project is in the early stages of development.
+> It is not ready for use yet.
+
+## What is Textual Code?
+
+Textual Code is a TUI-based code editor that feels familiar right from the start.
+
+You’ve probably had to SSH into a server at some point just to tweak a few lines of code.
+However, vi or Emacs can be overkill for quick fixes, requiring you to remember a whole host of commands for even the simplest changes.
+Furthermore, nano doesn’t always provide enough features for comfortable coding, and setting up a GUI editor on a remote server can be a real hassle.
+
+That’s why Textual Code was created.
+You likely use a GUI editor like VS Code or Sublime Text in your day-to-day work, and Textual Code offers a similar experience with no learning curve.
+It behaves much like any other code editor you’re used to.
+
+We’re not asking you to switch to Textual Code as your main editor.
+Just remember it’s there when you need to jump onto a server and make a few quick edits.
+It’s that simple.
+
+## Features
+
+> [!WARNING]  
+> This project is in the early stages of development.
+> the features listed below are not yet implemented or are only partially implemented.
+
+- Commonly used shortcuts, such as `Ctrl+S` to save and `Ctrl+F` to search
+- Command palette for quick access to all features, and no need to remember shortcuts
+- Multiple cursors
+- Mouse support
+- Find and replace from workspace
+- Explore files in the sidebar
+- Open files to tabs
+- Syntax highlighting
+
+## Installation
+
+```bash
+pip install textual-code
+```
+
+## Usage
+
+To open the textual code, run the following command in your workspace:
+
+```bash
+textual-code
+```
+
+## Development
+
+(You need to use devcontainer to run the code)
+
+To run the development version directly:
+
+```bash
+uv run textual-code
+```
+
+To run with the Textual dev console (shows logs and events), open two terminals:
+
+```bash
+# Terminal 1: start the console
+uv run textual console
+
+# Terminal 2: run the app in dev mode
+uv run textual run --dev textual_code:main
+```
+
+### Running Tests
+
+See [docs/testing-guide.md](docs/testing-guide.md) for patterns, best practices, and gotchas.
+
+```bash
+# Unit/integration tests — parallel (~2.5 min)
+uv run pytest tests/ -n $(( $(nproc) * 2 )) -m "not serial"
+
+# Snapshot tests — must run serially
+uv run pytest tests/ -m serial
+
+# Update snapshots after UI changes
+uv run pytest tests/test_snapshots.py --snapshot-update
+
+# Single file
+uv run pytest tests/test_code_editor.py
+```

textual_code-0.1.1/README.md

@@ -0,0 +1,92 @@
+# Textual Code
+
+Code editor for who don't know how to use vi
+
+![Screenshot](tests/__snapshots__/test_snapshots/test_snapshot_readme_preview.svg)
+
+> [!WARNING]  
+> This project is in the early stages of development.
+> It is not ready for use yet.
+
+## What is Textual Code?
+
+Textual Code is a TUI-based code editor that feels familiar right from the start.
+
+You’ve probably had to SSH into a server at some point just to tweak a few lines of code.
+However, vi or Emacs can be overkill for quick fixes, requiring you to remember a whole host of commands for even the simplest changes.
+Furthermore, nano doesn’t always provide enough features for comfortable coding, and setting up a GUI editor on a remote server can be a real hassle.
+
+That’s why Textual Code was created.
+You likely use a GUI editor like VS Code or Sublime Text in your day-to-day work, and Textual Code offers a similar experience with no learning curve.
+It behaves much like any other code editor you’re used to.
+
+We’re not asking you to switch to Textual Code as your main editor.
+Just remember it’s there when you need to jump onto a server and make a few quick edits.
+It’s that simple.
+
+## Features
+
+> [!WARNING]  
+> This project is in the early stages of development.
+> the features listed below are not yet implemented or are only partially implemented.
+
+- Commonly used shortcuts, such as `Ctrl+S` to save and `Ctrl+F` to search
+- Command palette for quick access to all features, and no need to remember shortcuts
+- Multiple cursors
+- Mouse support
+- Find and replace from workspace
+- Explore files in the sidebar
+- Open files to tabs
+- Syntax highlighting
+
+## Installation
+
+```bash
+pip install textual-code
+```
+
+## Usage
+
+To open the textual code, run the following command in your workspace:
+
+```bash
+textual-code
+```
+
+## Development
+
+(You need to use devcontainer to run the code)
+
+To run the development version directly:
+
+```bash
+uv run textual-code
+```
+
+To run with the Textual dev console (shows logs and events), open two terminals:
+
+```bash
+# Terminal 1: start the console
+uv run textual console
+
+# Terminal 2: run the app in dev mode
+uv run textual run --dev textual_code:main
+```
+
+### Running Tests
+
+See [docs/testing-guide.md](docs/testing-guide.md) for patterns, best practices, and gotchas.
+
+```bash
+# Unit/integration tests — parallel (~2.5 min)
+uv run pytest tests/ -n $(( $(nproc) * 2 )) -m "not serial"
+
+# Snapshot tests — must run serially
+uv run pytest tests/ -m serial
+
+# Update snapshots after UI changes
+uv run pytest tests/test_snapshots.py --snapshot-update
+
+# Single file
+uv run pytest tests/test_code_editor.py
+```