bottlecap

command module
v0.0.3 Latest Latest
Warning

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

Go to latest
Published: May 22, 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. Build the binary with make build or dowload it from GitHub Releases

  3. Within the repo, modify the config file accordingly, or create your own config.json file in the same directory as the binary, with the following fields:

    {
        "url": "https://example.com", # url of the LLM (including port if necessary)
        "bearerToken": "<your bearer token>", # bearer token, if required
        "model": "<optionally-specify-model>", # name / id of model (such as llama-scout-maas)
        "chatInstructions": "You are a helpful assistant.", # system prompt for chat
        "imageInstructions": "Describe this image." # system prompt for "image" subcommand
    }
    
  4. 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?"
    
    ./bottlecap image "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"
    
    ./bottlecap generate "Create an image of a dog in sunglasses."
    

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

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