Skip to content

Logseq Doctor

Documentation Go Build Status Coverage Status

Logseq Doctor: heal your flat old Markdown files before importing them to Logseq.

Project Status

This project is still in alpha, so it's very rough on the edges (documentation and feature-wise).

What is Logseq Doctor?

Logseq Doctor is a command-line tool with commands to manipulate your Logseq Markdown files. It provides utilities to:

  • Convert flat Markdown to Logseq's outline format
  • Append content to pages and journals
  • Create task backlogs that are easily viewed and prioritized in the mobile app
  • Manage tasks in Logseq
  • Clean up and tidy Markdown files
  • Prevent invalid content to be committed
  • And more stuff to come...

Features

  • Backlog Management (backlog): Aggregate tasks from multiple pages into unified backlogs with smart categorization, overdue detection, and focus page generation
  • Content Management (content): Append raw Markdown content to Logseq pages or journals
  • Markdown Integration (md): Parse and add Markdown content using DOM manipulation with support for parent blocks and journal targeting
  • Task Management (task add): Add new tasks or update existing ones with key-based search, preserving children and properties
  • Tidy Up (tidy-up): Clean up and standardize your Markdown files
  • Fast Performance: Written in Go for speed and efficiency
  • Outline Conversion (outline): Convert flat Markdown files to Logseq's outline format
  • Task Listing (tasks): List and manage tasks in your Logseq graph

Installation

Installation

To install the most updated version:

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

Confirm if it's in your path:

Text Only
type -p lqd
# or
which lqd
# or
ls -l $(go env GOPATH)/bin/lqd

On macOS and Linux, you can also install it with Homebrew:

Text Only
brew install andreoliwa/formulae/logseq-doctor

Build from source

To build and install the lqd binary from source, clone the repository and run:

Text Only
make install

Quick Start

Quick start

Type lqd without arguments to check the current commands and options:

Text Only
Logseq Doctor heals your Markdown files for Logseq.

Convert flat Markdown to Logseq outline, clean up Markdown,
prevent invalid content, and more stuff to come.

Usage:
lqd [command]

Available Commands:
backlog     Aggregate tasks from multiple pages into a backlog
completion  Generate the autocompletion script for the specified shell
content     Append raw Markdown content to Logseq
dashboard   Start PocketBase and the backlog web UI
groom       Interactively review and groom stale tasks
help        Help about any command
md          Add Markdown content to Logseq using the DOM
outline     Convert flat Markdown to a Logseq bullet outline
sync        Sync Logseq tasks to PocketBase
task        Manage tasks in Logseq
tidy-up     Tidy up your Markdown files.

Flags:
-h, --help   help for lqd

Use "lqd [command] --help" for more information about a command.

Project Goals

The primary goal of Logseq Doctor is to make it easier to migrate existing Markdown content into Logseq. Whether you're coming from another note-taking system or have a collection of flat Markdown files, Logseq Doctor helps ensure your content is properly formatted for Logseq's outliner-based structure.

License

This project is licensed under the MIT License.