Skip to content

Clerkie-cli is a terminal tool that uses an LLM to help debug and troubleshoot coding errors in any programming language. It offers explanations, suggested fixes, guidance, alternative approaches, and code examples. It is useful for developers of all skill levels.

Notifications You must be signed in to change notification settings

BerriAI/clerkie-cli

Repository files navigation

Clerkie-cli

Clerkie-cli is a terminal tool that uses a large language model (LLM) to provide suggestions and assistance when you encounter errors in your code. It is designed to help developers of all skill levels improve their productivity and efficiency by providing them with quick and accurate solutions to common coding problems.

"Buy Me A Coffee"

Features

  • Analyzes stack traces in any programming language and provides explanations and suggested fixes
  • Offers guidance on debugging and troubleshooting techniques
  • Provides code snippets and examples to help you debug errors
  • Automatic in terminal error detection and suggested fixes

Installation

Requirements: As of now Clerkie-cli only works for Zsh shell, Macs default to zsh https://support.apple.com/guide/terminal/change-the-default-shell-trml113/mac#:~:text=The default shell is zsh,windows and tabs open with. We are working to add support for bash

To install Clerkie-cli, open a terminal and run the following command:

curl -fsSL https://raw.githubusercontent.com/ClerkieAI/clerkie-cli/main/install.sh -o install.sh
chmod +x install.sh
./install.sh

This will download and install the latest version of Clerkie-cli on your machine. Once the installation is complete, you need to open a new Terminal Window and Clerkie will be active

Usage

Clerkie-cli automatically runs whenever it notices an error in your terminal. Simply run your code as you normally would, and if an error occurs, Clerkie-cli will provide you with an explanation of the error and suggest potential fixes.

carbon carbon (2)

Clerkie-cli will then provide you with an explanation of the error and suggest potential fixes.

How to disable Clerkie-cli

Open ~/.zshrc and delete the following lines (you can edit zshrc using vi ~/.zshrc)

# clerkie-cli configs
export CLERKIE_SRC=/Users/daddyish/.clerkie-cli/clerkie-src
[[ -f "$HOME/.clerkie-cli/clerkie-src/setup.sh" ]] && builtin source "$HOME/.clerkie-cli/clerkie-src/setup.sh"

Support

If you have any questions or need help using Clerkie-cli, you can reach out to us through the following channels:

We are always happy to help!

Testimonials

We have been Featured in Ben Tossel's AI Newsletter User Testimonial User Testimonial User Testimonial

About

Clerkie-cli is a terminal tool that uses an LLM to help debug and troubleshoot coding errors in any programming language. It offers explanations, suggested fixes, guidance, alternative approaches, and code examples. It is useful for developers of all skill levels.

Resources

Stars

Watchers

Forks

Packages

No packages published