bottlecap

command module
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: May 21, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

About

bottlecap is a simple Go client for interacting with OpenAI compatible LLM servers run locally or elsewhere. The app is meant to provide a more streamlined experience for interacting with these LLMs in chatbot style via CLI.

Instructions (local LLM)

  1. git clone https://github.com/cadenmarchese/bottlecap

  2. Within the repo, modify the config file accordingly, or provide your own config file, with the following fields:

    {
        "url": "https://example.com/v1/chat/completions",
        "bearerToken": "<your bearer token>",
        "model": "<optionally-specify-model>",
        "chatInstructions": "You are a helpful assistant.",
        "imageInstructions": "Describe this image."
    }
    
  3. Ask away.

    NAME:
    bottlecap - Provide inputs to the bottelecap application using quotes
    
    USAGE:
    bottlecap [global options]
    
    GLOBAL OPTIONS:
    --help, -h  show help
    
    ./bottlecap ask "Why is the sky blue?"
    

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
client
client interacts with the local LLM based on the config file
client interacts with the local LLM based on the config file

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL