Skip to content

loupekind docs

What loupekind docs does

Browse this documentation in an interactive terminal markdown browser, without a network connection. The pages are embedded in the binary at build time, so what you read is the documentation that shipped with your version.

Usage

loupekind docs
loupekind docs serve
loupekind docs serve --port 9000 --open=false

Subcommands

Subcommand What it does
serve Serve the same documentation as a local static site, on 127.0.0.1:8080 by default

Flags on docs serve

Flag Short What it does
--port -p Port to listen on; 0 picks a free one (default 8080)
--host Interface to bind (default 127.0.0.1; 0.0.0.0 exposes it to the network, trusted networks only)
--open Open the browser once serving (default true)

Plus the global flags on every command.

loupekind docs --help also lists a --provider flag. It does nothing in LoupeKind: the framework registers it for docs ask, which LoupeKind doesn't have. That's a framework bug, go-tool-base #98.

There is no docs ask

LoupeKind does not carry the framework's AI question-answering over the embedded docs: that facility follows the ai feature, which LoupeKind does not enable. Questions about the images themselves go to loupekind review, which sends frames to a model; the documentation is for reading, in the terminal or in the browser.

A go install build has no documentation to browse

Both loupekind docs and loupekind docs serve require a binary built with the embedded documentation assets. A plain go install or go build omits them, and the command has nothing to show.

Use a release archive, the packaged macOS app, or just build / just install from a source checkout, all of which run the generate step that embeds the assets. This is the same reason a go install build has a broken studio; see Getting started.