Logseq CLI FAQs

Question 1

What are the unique output features of Logseq CLI?

Accepted Answer

Logseq CLI primarily outputs structured NDJSON, making it ideal for piping into tools like `jq`. It also offers a `--plain` mode for human-readable key:value pairs for interactive use, and a `--fields` option to trim output to specific keys, which is beneficial for LLM agents.

Question 2

What are the requirements to use Logseq CLI?

Accepted Answer

You need Python 3.10+ installed, the Logseq Desktop application running with its HTTP API server enabled, and the API token configured (via an environment variable or `.env` file). It is compatible with Windows, macOS, and Linux.

Question 3

What is Logseq CLI and what does it do?

Accepted Answer

Logseq CLI is a command-line interface that integrates Logseq with its local HTTP API. It enables you to interact with your Logseq graph (pages, blocks, queries) directly from the command line, facilitating Unix-composable workflows for both human users and AI agents.

Question 4

How does Logseq CLI support AI agents and automated workflows?

Accepted Answer

It's designed for AI agents by outputting structured NDJSON by default, which is easily parseable. Features like auto-stdin composition, `--fields` filtering (for token efficiency), and errors on stderr ensure clean, predictable data streams for agentic and automated workflows without glue code.

Question 5

What kind of Logseq operations can I perform with the CLI?

Accepted Answer

You can perform a wide range of operations including listing, getting, creating, updating, and deleting pages and blocks. You can also run Datalog queries, manage block properties, and leverage advanced features like piping to filter and transform data.

Logseq CLI

Logseq CLI

Key Features

Use Cases

Key Features

Use Cases