Skip to main content

GenSh - Generate and execute code using natural language

Project description

GenSh - Generate and Execute Shell

GenSh is a command-line tool that allows you to generate and execute code using natural language prompts. It leverages large language models to translate your queries into Python or shell code and then executes the generated code.

Features

[x] Generate and execute Python or shell code from natural language queries [x] Support for multiple LLM backends: OpenAI GPT, Anthropic Claude, and Ollama [x] Web search integration to improve code generation [x] Interactive shell mode [x] Command-line execution mode [x] Configurable settings via JSON configuration file [x] Verbose mode for detailed output [x] Error handling and retry logic for code generation [x] Pre-defined templates for common tasks [x] Logging of language model calls to SQLite database [x] Session-based conversation history [x] API token management using .env file

TODO

  • Ask for changes:
    • Add new features or test cases.
    • Describe a bug.
    • Paste in an error message or or GitHub issue URL.
    • Refactor code.
    • Update docs.
  • Will edit your files to complete your request.
  • Automatically git commits changes with a sensible commit messag

Requirements

GenSh requires the following:

  • Python 3.7 or higher
  • OpenAI API key (for GPT-3.5 or GPT-4 access)
  • Anthropic API key (for Claude access)
  • Ollama installed locally (for running local models)
  • Dependencies (installed automatically):
    • openai>=1.0.0
    • anthropic>=0.3.0
    • PyYAML>=6.0
    • ollama>=0.1.0
    • python-dotenv>=0.19.0
    • markdown>=3.3.0
    • python-docx>=0.8.10
    • requests>=2.25.0
    • beautifulsoup4>=4.9.3

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/gensh.git
    cd gensh
    
  2. Install the package:

    pip install .
    

Setting up API Keys

Create a .env file in the root directory of your project and add your API keys:

OPENAI_API_KEY=your_openai_api_key_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here

Usage

Interactive Mode

To start the interactive shell:

gensh

Command-Line Execution

To run a single command:

gensh -c '"find your ip address" | python'

Batch Processing

To process commands from a file:

gensh -f example_batch.txt

Output Formats

Specify the output format:

gensh --output markdown
gensh --output docx

Verbose Mode

Enable verbose output:

gensh -v

Custom Configuration

Use a custom configuration file:

gensh --config /path/to/custom_config.json

Configuration

Create a configuration file at ~/.gensh_config.json with the following structure:

{
    "template_dir": "templates",
    "model": "gpt-3.5-turbo",
    "execution_timeout": 30,
    "max_retries": 3,
    "retry_delay": 1,
    "db_path": "gensh_logs.db",
    "output_format": "text"
}

Development

To set up a development environment:

  1. Clone the repository
  2. Install dependencies: pip install -e ".[dev]" or poetry install
  3. Run tests: pytest tests/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

BUGS / FEATURES / TODO

[x] Bug: Release base templates with the shell, list_templates is broken. DONE: added resources [x] Bug: History functionality doesnt work - DONE: added show_model commands [ ] Feat: Ability to inject on variables in templates, ask for template input [ ] Feat: Add test cases for functionality like generate | parse_context | exec_code [ ] Feat: Add an eval suite which is based on exercism.org code templates [ ] Feat: Add voice capability [ ] Feat: Multiple output formats: text, Markdown, and Word document (docx) [ ] Feat: Batch processing of commands from a file

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

gensh-0.1.6.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

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

gensh-0.1.6-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file gensh-0.1.6.tar.gz.

File metadata

  • Download URL: gensh-0.1.6.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.4

File hashes

Hashes for gensh-0.1.6.tar.gz
Algorithm Hash digest
SHA256 2e9f0134755a03687d58a5d723854e7a098a36193c456cf3eea018af7b635034
MD5 f8d8a3e7f6e905f28ef8b4701992877a
BLAKE2b-256 c534f02672ec3d11cedcda6f4a2292d1d37edf3dd2db936947d2142366949616

See more details on using hashes here.

File details

Details for the file gensh-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: gensh-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.4

File hashes

Hashes for gensh-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 fa034afa2940d011224245acf9a64b98bd2e1ec0e1a8c60c2e6efd8b472affae
MD5 868a2d9d331dfe9d6df098d20bdae773
BLAKE2b-256 77955c7bbbd8bc2e0a0c5913759419e848340098761c86a5396721f86857cf86

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