Skip to main content

Terminal Operation Natural Instruction - AI-powered terminal assistant

Project description

TONI - Terminal Operation Natural Instruction

TONI is a lightweight CLI tool that translates natural language into terminal commands using AI. Simply describe what you want to do, and TONI will suggest the appropriate command for your system.

PyPI version

Inspiration

TONI was inspired by YAI (Yet Another Interpreter), but with a focused approach. While YAI offers a comprehensive terminal experience, TONI is designed specifically to suggest and execute single commands based on natural language descriptions.

Features

  • Translates natural language to terminal commands
  • Prioritizes Google Gemini AI with OpenAI fallback
  • System-aware: Detects whether you're on Linux (Arch, Debian, etc.), macOS, or other systems
  • Verifies command availability before execution
  • Saves executed commands to ZSH history (when using ZSH)
  • Simple to use and install

Installation

# Install from PyPI
pip install toni-cli

# Or with pipx (recommended)
pipx install toni-cli

Configuration

TONI requires at least one API key to function:

  1. For Google Gemini (preferred):
export GOOGLEAI_API_KEY='your-gemini-api-key'
  1. For OpenAI (fallback):
export OPENAI_API_KEY='your-openai-api-key'

Add these lines to your shell configuration file (~/.bashrc, ~/.zshrc, etc.) to make them persistent.

Usage

Simply type toni followed by your natural language description:

# Basic file operations
toni list all pdf files in current directory
toni find all files modified in the last 7 days

# System queries
toni show my disk usage
toni what processes are using the most memory

# Complex tasks
toni create a backup of my Documents folder
toni find the largest files in this directory

Examples

$ toni find all python files containing the word "error"

Detected system: Linux (arch)
Suggested command: grep -r "error" --include="*.py" .
Explanation: Search recursively for the word "error" in all Python files in the current directory
Do you want to execute this command? (y/n):

Development

To contribute to TONI:

  1. Clone the repository:
git clone https://github.com/yourusername/toni.git
cd toni
  1. Create a virtual environment:
python -m venv venv
source venv/bin/activate
  1. Install for development:
pip install -e ".[dev]"
  1. Make your changes and submit a pull request!

License

MIT

Acknowledgements

  • YAI for the inspiration
  • Google Gemini and OpenAI for their powerful AI APIs

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

toni_cli-0.1.3.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

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

toni_cli-0.1.3-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file toni_cli-0.1.3.tar.gz.

File metadata

  • Download URL: toni_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for toni_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 962d6b7502bca9387699eb069dc0e6f04bb52317de928f492f6a46ee7a91d422
MD5 2203a990934b3ea27642fb32d1db29a3
BLAKE2b-256 1aa40d40d90dcb183fd79c3964dfc3b437091628f47cfc0311580bf7c0a3f6ca

See more details on using hashes here.

File details

Details for the file toni_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: toni_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for toni_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7505cc4b7a44152ba1ef11bca1dd2efcdcb80a8fc37ed647a13f7cb040f6bc91
MD5 3d538ef494a2b8a7aa6a53663b0afb9f
BLAKE2b-256 3127815f3473bd2e041d989aa4f022658786a8d9c81203f4ff4e64b7dbc94a04

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