Metadata-Version: 2.4
Name: null-terminal
Version: 0.0.2
Summary: A next-generation AI-integrated TUI terminal emulator.
Project-URL: Homepage, https://github.com/starhound/null
Project-URL: Issues, https://github.com/starhound/null/issues
Author-email: Starhound <starhound@lostsouls.org>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Console :: Curses
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: anthropic>=0.75.0
Requires-Dist: asyncssh>=2.14.2
Requires-Dist: boto3>=1.42.19
Requires-Dist: cohere>=5.20.1
Requires-Dist: cryptography>=46.0.3
Requires-Dist: google-genai>=0.1.0
Requires-Dist: httpx>=0.28.1
Requires-Dist: keyring>=25.7.0
Requires-Dist: openai>=2.14.0
Requires-Dist: pyperclip>=1.11.0
Requires-Dist: pyte>=0.8.2
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: rich>=14.2.0
Requires-Dist: textual>=6.11.0
Description-Content-Type: text/markdown


# Null Terminal

> **"Shell in the Void."**

> [!NOTE]
> Null Terminal is under active development and not yet officially released. Features and APIs may change.

Null is a next-generation TUI (Terminal User Interface) designed for the modern AI-integrated workflow. Built on [Textual](https://textual.textualize.io/), it blends the raw power of the command line with the intelligence of LLMs, all wrapped in a sleek, cyber-noir aesthetic.

<p align="center">
  <img src="docs/null_graphic.png" alt="Null Terminal" width="600">
</p>

## 📖 Documentation

-   [**User Guide**](docs/user/README.md): Comprehensive guide with commands, shortcuts, and configuration.
-   [**Architecture**](docs/ARCHITECTURE.md): System design, event loops, and state management.
-   [**Development**](docs/DEVELOPMENT.md): Setup, contributing, and extending the codebase.

## ✨ Features

-   **AI Integration**: Seamless chat with OpenAI, Ollama, LM Studio, and more.
-   **Input Modes**: Switch between shell and AI modes with ease.
-   **Context Awareness**: Smartly manages files and conversation history.
-   **Local Tool Use**: AI can run commands, read files, and analyze code directly.
-   **MCP Support**: Connect to Model Context Protocol servers for extended tool capabilities.
-   **Chain of Thought**: Visualize the reasoning process of advanced models (e.g., DeepSeek R1).
-   **Cyber-Noir Aesthetics**: Beautiful, customizable themes and animations.

## 🚀 Quick Start

### Install via pipx

```bash
pipx install null-terminal
null
```

### Run with Docker

```bash
docker run -it ghcr.io/starhound/null:latest
```

### From Source (Development)

```bash
git clone https://github.com/starhound/null.git
cd null
uv sync
uv run main.py
```

### Configure

Type `/settings` to configure your AI provider, or press `F3` to change theme.

## 🎬 Demo

<p align="center">
  <img src="docs/demo.gif" alt="Null Terminal Demo" width="700">
</p>

## ⌨️ Key Controls

| Shortcut | Action |
|----------|--------|
| `Ctrl+Space` | Toggle AI/CLI mode |
| `Ctrl+P` | Command palette |
| `Ctrl+C` | Cancel or quit |
| `F1` | Help screen |
| `F2` | Select model |
| `F3` | Change theme |
| `F4` | Select provider |

See [full shortcut reference](docs/user/shortcuts.md) for more.

---

<p align="center">
  Built with 🖤 by Starhound
</p>
