mindterm 0.3.0

Intelligent terminal like thinking.

Mind Terminal

Overview

Terminal large language model client implemented using Python with a modular architecture.

Technology Stack

• Use UV to manage development environments and third-party dependencies.
• Use the prompt-toolkit to handle user input and interaction.
• Interact with the backend large language model service using openai-python
• Use the rich library to beautify terminal display.
• Use Pytest testing ensures the correctness of each module and function.

Features

• Handle user input
• Interact with the backend large language model
• Write unit tests for interacting with LLM
• Beautify terminal display with Rich formatting
• Modular code structure
• Configuration management
• Error handling

Installation

Ensure you are using Python 3.11 or later (but less than 4.0).

pip install mindterm --user

Usage

Set your OpenAI API key as an environment variable:

export OPENAI_API_KEY=your-api-key-here

Then run the application:

mt

Commands

• \chat - Start a chat session (default mode)
• \bye - Exit the application
• \help - Show available commands

Testing

Tests for the app are included using pytest. To run the tests, simply execute:

uv run pytest

Project Structure

src/
├── mindterm/
│   ├── __init__.py
│   ├── config.py      # Configuration management
│   ├── client.py      # LLM client
│   ├── ui.py          # Terminal UI components
│   ├── commands.py    # Command handling
│   └── main.py        # Main application logic
tests/
├── test_config.py     # Tests for configuration
└── test_commands.py   # Tests for command handling

Contributing

Contributions are welcome! If you have ideas for improvements, bug fixes, or additional features, feel free to open an issue or submit a pull request.

License

This App is open-source software released under the MIT License.