Skip to content

sheenazien8/askme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AskMe

No more laziness searching for answers on the internet or the whole thing with AI. With AskMe, find anything through the terminal easily. Simple and efficient: search, get answers, and get on with your work without excessive chatter.

# AskMe CLI

AskMe is a command-line interface (CLI) tool that allows you to generate responses based on a given prompt using a specified model. This tool is designed to be simple and easy to use, providing a seamless experience for querying and generating responses.

## Features

- Prompt-based interaction
- Configurable default model
- Spinner animation while generating responses
- Error handling and user prompts

## Installation

To install AskMe, clone the repository and build the Go application:

```sh
git clone https://github.com/sheenazien8/askme.git
cd askme-cli
make build

Usage

You can use AskMe by running the askme command followed by your prompt. You can also specify a model using the --model flag.

Basic Usage

./bin/askme "Explain Go channels"

Specify a Model

./bin/askme --model codegen "What are goroutines?"

Help

To display help information, use the --help flag:

./bin/askme --help

Configuration

You can set a default model in the configuration file located at ~/.config/askme/config.yaml. The configuration file should be in YAML format and contain the following structure:

provider: ollama | mistral
default_model: your_default_model_name
mistral_api_key: <if you using mistral>

Example

./bin/askme "What is the capital of France?"

License

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

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

Roadmap

Here are some planned features and improvements for future releases:

  • Implement logic ollama installation
  • Add unit tests and improve test coverage
  • Enhance error handling and user feedback
  • Add provider support

Acknowledgements

Special thanks to the developers and contributors of the libraries and tools used in this project.

About

Generative AI wrapper in cli

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published