AI for the command line, built for pipelines.
LLM based AI is really good at interpreting the output of commands and returning the results in CLI friendly text formats like Markdown. Mods is a simple tool that makes it super easy to use AI on the command line and in your pipelines. Mods works with OpenAI and LocalAI
Github Link - https://github.com/charmbracelet/mods
What Can It Do?
Mods works by reading standard in and prefacing it with a prompt supplied in
mods arguments. It sends the input text to an LLM and prints out the
result, optionally asking the LLM to format the response as Markdown. This
gives you a way to “question” the output of a command. Mods will also work on
standard in or an argument supplied prompt individually.
Mods works with OpenAI compatible endpoints. By default, Mods is configured to
support OpenAI’s official API and a LocalAI installation running on port 8080.
You can configure additional endpoints in your settings file by running
LocalAI allows you to run a multitude of models locally. Mods works with the
GPT4ALL-J model as setup in this tutorial.
You can define more LocalAI models and endpoints with
# macOS or Linux brew install charmbracelet/tap/mods # Arch Linux (btw) yay -S mods # Debian/Ubuntu sudo mkdir -p /etc/apt/keyrings curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list sudo apt update && sudo apt install mods # Fedora/RHEL echo '[charm] name=Charm baseurl=https://repo.charm.sh/yum/ enabled=1 gpgcheck=1 gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo sudo yum install mods
Or, download it:
- Packages are available in Debian and RPM formats
- Binaries are available for Linux, macOS, and Windows
Or, just install it with
go install github.com/charmbracelet/mods@latest
Conversations save automatically. They are identified by their latest prompt. Similar to Git, conversations have a SHA-1 identifier and a title. Conversations can be updated, maintaining their SHA-1 identifier but changing their title.
Mods lets you tune your query with a variety of settings. You can configure
mods --settings or pass the settings as environment variables
gpt-4 with OpenAI by default but you can specify any model as long
as your account has access to it or you have installed locally with LocalAI.
You can add new models to the settings with
You can also specify a model and an API endpoint with
to use models not in the settings file.
Set a custom save title for the conversation.
Continues the previous conversation.
Continue from the last response or a given title or SHA1.
Lists all saved conversations.
Show the saved conversation the given title or SHA1.
Deletes the saved conversation with the given title or SHA1.
Format As Markdown
Ask the LLM to format the response as markdown. You can edit the text passed to
the LLM with
mods --settings then changing the
Print the raw response without syntax highlighting, even when connect to a TTY.
Max tokens tells the LLM to respond in less than this number of tokens. LLMs are better at longer responses so values larger than 256 tend to work best.
Sampling temperature is a number between 0.0 and 2.0 and determines how confident the model is in its choices. Higher values make the output more random and lower values make it more deterministic.
Top P is an alternative to sampling temperature. It’s a number between 0.0 and 2.0 with smaller numbers narrowing the domain from which the model will create its response.
By default Mods attempts to size the input to the maximum size the allowed by the model. You can potentially squeeze a few more tokens into the input by setting this but also risk getting a max token exceeded error from the OpenAI API.
Include prompt will preface the response with the entire prompt, both standard in and the prompt supplied by the arguments.
Include Prompt Args
Include prompt args will include only the prompt supplied by the arguments. This can be useful if your standard in content is long and you just a want a summary before the response.
The maximum number of retries to failed API calls. The retries happen with an exponential backoff.
Your desired level of fanciness.
Output nothing to standard err.
Backup your old settings file and reset everything to the defaults.
Disables conversation saving.
Use the HTTP proxy to the connect the API endpoints.