Skip to main content

AI assistant for your terminal

Project description

terminaider

AI within your terminal 🤖

Description

Quickly prompt any supported AI from within your terminal, without being bound to any specific provider.

terminaider demo

Features

  • Currently supports GROQ APIs
  • Prompt caching
  • Software engineering focus (for now)

Installation

  1. Ensure you have Go installed on your system.

  2. Clone the repository and install:

git clone https://github.com/Danielratmiroff/terminaider.git
cd terminaider
go install
  1. Set up your API key:

    Option 1: Set an environment variable:

    export GROQ_API_KEY="your_api_key_here"
    

    Option 2: Create a config.yaml file in the repo folder:

    GroqAPIKey: "your_api_key_here"
    

Usage

Basic Usage

terminaider

Prompt on Startup

terminaider How big is the Earth?

Quick Command (copies executable command to clipboard)

terminaider -r How can I commit my changes to git?

Recommendation: Create an Alias

Add this line to your shell configuration file (e.g., ~/.zshrc or ~/.bashrc):

alias ai='terminaider'

Then reload your shell or run source ~/.zshrc (or respective config file).

Now you can use ai as a shortcut:

ai is the earth flat?

Contributing

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

License

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

terminaider-0.1.0.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

terminaider-0.1.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: terminaider-0.1.0.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for terminaider-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3b29d9358ba7db900f6123abb62854e1b846f79f606d14944c4da3588cd14448
MD5 e12116e48605093784158b93431f7ca4
BLAKE2b-256 98b5ddd4a59ebc1c6e03f353f80582aeec1bf750f2e587dbcfdbebe4821782d5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: terminaider-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for terminaider-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 989b934f2f7992f2a4a3398b3ea48431e13f341f7073e25cc9a2d7e43ab1178a
MD5 719c36755bfcd962e7390f0f8913aa83
BLAKE2b-256 dd9282d186c1c3abf2d7752ddf47b9d99c53821945a95cf4a1c7e8de5c08b4d7

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page