Skip to main content

A professional iterative CLI AI Agent powered by Ollama

Project description

askme-ai-cli

askme-ai-cli is a professional-grade, iterative CLI AI agent designed to act as a "doer" in your local development environment. Powered by Ollama, it combines advanced reasoning with the ability to execute shell commands, analyze project structures, and modify files directly.

Key Features

  • Iterative Reasoning (ReAct Pattern): The agent doesn't just provide one-shot answers. It analyzes requests, plans actions, observes command outputs, and refines its steps until the goal is achieved.
  • Local & Private: Runs entirely on your local machine or private infrastructure using Ollama models (Gemma, Llama 3, Mistral, etc.).
  • Smart Execution Suite:
    • <execute>: Handles standard commands safely.
    • <execute_shell>: Supports complex shell operations including pipes (|) and redirects (>).
    • <patch>: Applies unified diffs to files for precise code modifications without overwriting entire files.
  • Context Awareness: Automatically generates directory trees and maintains a "State of the Project" summary to keep the LLM focused.
  • Security Shield: Built-in protection against destructive commands (like rm -rf /) and unauthorized directory traversal.
  • Rich UI: A clean, professional terminal interface powered by the rich library, featuring live output streaming and session metadata.

Installation

Ensure you have Python 3.12+ installed, then install via pip:

pip install askme-ai-cli

Requirements

  1. Ollama: You must have Ollama installed and running on your system.
  2. Models: By default, the agent looks for gemma2:9b (or your configured default). You can pull it using:
    ollama pull gemma2:9b
    
  3. API Key: Set your OLLAMA_API_KEY in your environment or enter it when prompted.

Usage

Interactive Mode

Simply run the command to start a conversation with the agent:

askme

One-Shot Task

Provide a prompt directly from the terminal:

askme -p "Create a new python script that fetches crypto prices and save it to crypto.py"

Options

  • -m, --model: Specify a custom Ollama model.
  • -s, --session: Load or save a specific session history.
  • -d, --dry-run: View proposed commands without executing them.

License

This project is 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

askme_ai_cli-0.4.5.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

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

askme_ai_cli-0.4.5-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file askme_ai_cli-0.4.5.tar.gz.

File metadata

  • Download URL: askme_ai_cli-0.4.5.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for askme_ai_cli-0.4.5.tar.gz
Algorithm Hash digest
SHA256 749b57973f158d7437e7a5f8d0308044444c931387672de46773cd851891859a
MD5 4047068601bce8f3860e964a60a6c494
BLAKE2b-256 82a75c0c47a1d47fe6fc2137820dc9031eaba3b675a825af9797fcfea1ba355b

See more details on using hashes here.

File details

Details for the file askme_ai_cli-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: askme_ai_cli-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for askme_ai_cli-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bdb6f333b356e7e3dc1cfd8f5dc1cd5d28ea2830af1926e690ee71eec9082816
MD5 071264da2e2f7e27cc8757c52a22bd31
BLAKE2b-256 0db0256b395646990a2960bc4c14760865a715a2510396c84ec9bea78e2b7e72

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