Skip to content

Installation

Arif Dogan edited this page Mar 4, 2025 · 1 revision

Installation

LLMDog can be installed through several methods depending on your operating system and preferences.

Prerequisites

  • [Go](https://golang.org/) version 1.16 or higher (for building from source)
  • Git (optional, but recommended for cloning the repository)

Installation Methods

Option 1: Homebrew (macOS)

For macOS users, the easiest way to install LLMDog is through Homebrew:

  1. Tap the repository:

    brew tap doganarif/LLMDog
  2. Install LLMDog:

    brew install LLMDog

Option 2: Building from Source

To build from source:

  1. Clone the repository:

    git clone https://github.com/doganarif/LLMDog.git
  2. Navigate to the project directory:

    cd LLMDog
  3. Build the application:

    go build -o llmdog ./cmd/llmdog
  4. (Optional) Move the binary to a directory in your PATH:

    # Linux/macOS
    sudo mv llmdog /usr/local/bin/
    
    # Or add to ~/bin if you have it in your PATH
    mv llmdog ~/bin/

Option 3: Using go install

You can also install directly using Go:

go install github.com/doganarif/llmdog/cmd/llmdog@latest

This will install the binary to your $GOPATH/bin directory.

Verifying Installation

To verify that LLMDog has been installed correctly:

llmdog --version

You should see the current version number displayed.

Configuration Location

LLMDog stores its configuration and bookmarks in the following location:

  • Linux/macOS: ~/.config/llmdog/
  • Windows: %USERPROFILE%\.config\llmdog\

Two main files are stored there:

  • config.json: Application settings
  • bookmarks.json: Saved bookmarks

These files will be created automatically when you first run LLMDog.

Updating LLMDog

Updating with Homebrew

If you installed with Homebrew, you can update with:

brew update
brew upgrade LLMDog

Updating from Source

To update from source:

  1. Navigate to your local repository:

    cd path/to/LLMDog
  2. Pull the latest changes:

    git pull
  3. Rebuild the application:

    go build -o llmdog ./cmd/llmdog
  4. Replace your existing binary if necessary.

Uninstalling

Uninstalling with Homebrew

brew uninstall LLMDog
brew untap doganarif/LLMDog  # Optional

Uninstalling a Manual Installation

  1. Remove the binary:

    # If installed to /usr/local/bin
    sudo rm /usr/local/bin/llmdog
    
    # Or if installed to ~/bin
    rm ~/bin/llmdog
  2. Remove configuration files (optional):

    rm -rf ~/.config/llmdog

Clone this wiki locally