Skip to main content

A human to command-line innterface tool powered by LLM models.

Project description

⚠️ Warning: Execute with Caution ⚠️

Do not execute unverified commands in your terminal. Executing unknown or untrusted commands can potentially damage your computer, destroy files, and result in data loss. Always ensure that the commands you run are safe and verified.

Disclaimer

We are not responsible for any mishaps or damages that may occur from using this software. It is highly recommended that you fully understand how this software works before using it.

How It Works

InitialTerm is a terminal application that leverages the Ollama API to convert user queries into command-line commands. When you input a query, the software sends it to the Ollama API, which processes the query using a specified model and returns a terminal command. This command is then displayed to you for execution. You have the option to confirm or cancel the execution of the generated command.

Please ensure that you review and understand the commands before executing them to prevent any unintended consequences.


InitialTerm

InitialTerm is a terminal application that uses the Ollama API to convert user queries into command-line commands. It supports both Windows and macOS operating systems.

Installation

To install InitialTerm in editable mode, use the following command:

pip install -e .

Ensure you have the necessary dependencies installed. You can find them in the requirements.txt file or install them manually using:

pip install ollama requests

Usage

To use InitialTerm, simply run the following command in your terminal:

initialterm

You can also specify a model to use by adding the --model option:

initialterm --model llama-3.2:3b

This will start the custom command prompt where you can enter your queries. The application will convert your queries into terminal commands using the specified model.

Type exit or quit to leave the command prompt.

Contributing

We welcome contributions to InitialTerm! If you'd like to contribute, please follow these guidelines:

  1. Fork the repository and create your branch from main.
  2. Make your changes and test them thoroughly.
  3. Submit a pull request with a clear description of your changes.

Feel free to open issues for bug reports or feature requests. We appreciate your feedback and contributions!

Requirements

  • Python 3.6+
  • Ollama API

License

This project is open-source and available under a permissive license. You are free to do whatever you want with this software, but please be safe and ensure that your actions do not cause harm to yourself, your data, or your computer.

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

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

initialterm-0.1.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

initialterm-0.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file initialterm-0.1.0.tar.gz.

File metadata

  • Download URL: initialterm-0.1.0.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for initialterm-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ddeae18855bd93a9a7ab3987931d9642d0e471a6f6fe41cb83498707a2cac92b
MD5 443c8689ec5457acafdb0abb5633d614
BLAKE2b-256 075ae90e574bd3abf30bf686162a8f230f8e69152946bd29e7383fb9735080a6

See more details on using hashes here.

File details

Details for the file initialterm-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: initialterm-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for initialterm-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9cbce8df5c120121f0362d1b3aee2b4ea7fdf4204c646cdbe4af303d14be0e29
MD5 b1add8d06428fb86721cfc7e52c9f8af
BLAKE2b-256 a180471afb0e656117f2ccea475a92e60ac36822ce40bdce090167fd650206c6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page