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.1.5.tar.gz (9.6 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.1.5-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: askme_ai_cli-0.1.5.tar.gz
  • Upload date:
  • Size: 9.6 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.1.5.tar.gz
Algorithm Hash digest
SHA256 94c60ad8c2239b0e53cbbd9189ad675f756903042f74f13e3e87841420564866
MD5 6d8ca360cab3c5ff5bc1bc6ddda7abab
BLAKE2b-256 bd285bc8fba3225cb0ba462de6bff0a116875f880157a05df797f6b760b70ef8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: askme_ai_cli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.7 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.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 79fe446f4a0ca2c66f83a4f29209172b1f8251bf91efbdc4403055c07ee603d0
MD5 2783bc1560ab1f5503fb2c969afdd649
BLAKE2b-256 54c8406419c0068d9aa88256ab6e8c3155ab545596328cbf42323e79e9a2f0ad

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