Skip to content

Installation

Logseq Doctor provides both Go and Python implementations. You can install either or both depending on your needs.

Go Binary Executable

macOS and Linux (Homebrew)

The recommended way for macOS and Linux is to install with Homebrew:

Bash
brew install andreoliwa/formulae/logseq-doctor

Manual Installation

You can install manually using Go:

Bash
go install github.com/andreoliwa/logseq-doctor/cmd/lqd@latest

Confirm if it's in your path:

Bash
which lqd
# or
ls -l $(go env GOPATH)/bin/lqd

Tip

Make sure your GOPATH/bin directory is in your system's PATH. You can add it to your shell profile:

Text Only
```bash
export PATH="$PATH:$(go env GOPATH)/bin"
```

Python Executable

The recommended way is to install logseq-doctor globally with pipx:

Bash
pipx install logseq-doctor

You can also install the development version with:

Bash
pipx install git+https://github.com/andreoliwa/logseq-doctor

You will then have the lqdpy command available globally in your system.

Alternative: pip

If you prefer to use pip:

Bash
pip install logseq-doctor

Warning

Installing with pip may conflict with other Python packages in your system. We recommend using pipx instead.

Build from Source

To build and install from the source (both Python and Go executables), clone the repository and run:

Bash
git clone https://github.com/andreoliwa/logseq-doctor.git
cd logseq-doctor
make install

This will:

  1. Set up a Python virtual environment
  2. Install Python dependencies
  3. Build the Go binary
  4. Install both executables

Verify Installation

Python CLI

Go CLI

Bash
lqd --help

You should see the help message with available commands.

Bash
lqdpy --help

You should see the help message with available commands.

Next Steps

Once installed, check out the Usage Guide to learn how to use Logseq Doctor.