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.5.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.5-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: toni_cli-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 1c785d4edfe9e02aa6e5d5de1a12254f186eadc90ab5a6694bdd875dc940af6f
MD5 50e90be8ee5c0f68ac7bf76fb7c8a12b
BLAKE2b-256 21e7db97a2ba451bcb7bcd422c55b05a15c793ad97f121c830f2e09f6b0fb83c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: toni_cli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 8.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 59f75545c4dd5f965c338810d3b116113adb53d1d683963d0dc62fd32022b56f
MD5 a4e532a4f1b4d9ceee1b4c082535cc49
BLAKE2b-256 16b231b2a1338b49fcb1c2640c064e338e5ca3ad4ce609eaeb61d96e67b07232

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