Skip to main content

A command-line AI assistant using Gemini

Project description

🧠 Canoaicli – AI Commands in Your Terminal

Canoaicli is a smart and minimalist CLI tool powered by Google Gemini. It transforms plain English instructions into terminal commands (bash, git, docker, etc.) – instantly.

⚡️ Quick Start

✅ Prerequisites

📦 Installation

Install directly from PyPI:

pip install canoaicli

🔐 Configure Gemini API

Before using, run:

ai configure

Enter your Gemini API key when prompted. It will be saved securely on your system.

💡 Example Usage

Transform any plain English question into ready-to-run commands:

ai ask "<your question>"

Examples:

ai ask "how to list all docker containers"
ai ask "delete all git branches except main"
ai ask "create a new virtual environment in python"

The tool will instantly generate and display the appropriate command(s).

✨ Refine Your Prompt

Use the --refine flag to improve the clarity of your prompt before sending it to the AI.

It rewrites your question in a clearer and more precise way, without changing its meaning. This helps the AI better understand your intent and provide more accurate responses.

Example:

ai ask --refine "find files that contain error"

🕘 View Command History

Canoaicli keeps track of your previous prompts and responses.

ai history

Search your history:

ai history --search <keyword>

Clear the history:

ai history clear

📖 Help / CLI Options

View all available commands and options:

ai --help

or simply:

ai -h

🛠️ Features

  • ✔️ Natural language → bash, git, docker, etc.
  • 🧠 Powered by Gemini AI
  • 🎨 Rich & interactive terminal UI
  • 🔐 Secure API key configuration
  • 📜 Local history with search
  • 🧩 Easy to extend and customize

🤖 Ideal For

  • Developers tired of googling shell commands
  • Beginners looking to learn by example
  • Productivity-focused engineers and power users

📦 Local development

To contribute to the project:

git clone https://github.com/carellihoula/AssistantIACLI.git
cd AssistantIACLI
pixi shell
pixi install

📄 License

Licensed under the MIT License.

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

canoaicli-1.2.0.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

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

canoaicli-1.2.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file canoaicli-1.2.0.tar.gz.

File metadata

  • Download URL: canoaicli-1.2.0.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for canoaicli-1.2.0.tar.gz
Algorithm Hash digest
SHA256 ebe8769391e61e2aa20f231395b03da826cb70b7e4465070d9364a6c072caecb
MD5 38715106a781706d0a48b63ddce6bc18
BLAKE2b-256 cabde6a6a31028fc962be68a5391ed027c182b7414296ab84501372f1e2a1fdc

See more details on using hashes here.

File details

Details for the file canoaicli-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: canoaicli-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for canoaicli-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2710de1dc716dd0682b91963d2bad4cfc25700da1541eed36d1b128ff6d42de0
MD5 3ff746917a795d5c481f6892c67270e3
BLAKE2b-256 6ab77b8481893ba8d34bcf33ab4be6ec98257ee78fb87bc9929b6ac36908c812

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