terminaider

command module
v0.0.0-...-c7edea8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳