Liking cljdoc? Tell your friends :D

hive-system.shell.tools

Tool registry: maps tool names to their binaries, descriptions, and install hints per package manager.

(require-tool :ripgrep) => (ok {:path "/usr/bin/rg"}) or (err :tool/missing {:hints [...]})

Tool registry: maps tool names to their binaries, descriptions,
and install hints per package manager.

(require-tool :ripgrep) => (ok {:path "/usr/bin/rg"})
                         or (err :tool/missing {:hints [...]})
raw docstring

list-toolsclj

(list-tools)

List all registered tools with their availability status.

List all registered tools with their availability status.
sourceraw docstring

register-tool!clj

(register-tool! tool-key {:keys [bin desc install] :as spec})

Dynamically register a new tool. Returns the updated registry entry.

Dynamically register a new tool. Returns the updated registry entry.
sourceraw docstring

require-toolclj

(require-tool tool-key)
(require-tool tool-key pkg-managers)

Check if a tool is available. Returns (ok {:path ... :bin ...}) or (err :tool/missing {:tool ... :hints ...}).

Available package managers are detected once and cached.

Check if a tool is available. Returns (ok {:path ... :bin ...})
or (err :tool/missing {:tool ... :hints ...}).

Available package managers are detected once and cached.
sourceraw docstring

require-toolsclj

(require-tools tool-keys)

Check multiple tools at once. Returns a map of {:available {...} :missing {...}}.

Check multiple tools at once. Returns a map of {:available {...} :missing {...}}.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close