Liking cljdoc? Tell your friends :D

hive-compose.promote.config

Addon config -> Settings. Pure: the profiles file's contents and the home directory arrive as values.

Config keys (manifest :addon/config, then config.edn :addons {"hive.compose" {..}}): :compose/profiles [Profile ..] or {id Profile}, inline :compose/profiles-file EDN file of the same shape (default ~/.config/hive-mcp/compose-profiles.edn) :compose/projects {id Project}: compose projects whose services and native profiles are addressable as targets (<project>/<target>) :compose/default-ttl-minutes idle minutes before the reaper acts (default 60) :compose/default-idle-action :stop | :down | :none (default :stop) :compose/tick-seconds reaper period (default 60) :compose/state-file default ~/.local/state/hive-compose/state.edn :compose/timeout-ms per compose call (default 60000) :compose/up-timeout-ms per up, pulls included (default 600000) :compose/adopt? adopt running stacks of configured profiles (default true) :compose/swarm? count agents working in a project's directories as use of its sections (default true) :compose/notify? shout nREPL routes and reaps to the swarm (default true) :compose/activity #{:nrepl :published}: which new connections count as use; :published (the host ports containers publish: a browser, any host-side client) is opt-in (default #{:nrepl}). A project overrides it for its sections with :project/activity, a preset with :profile/activity. Connections from the project's own containers never count. :compose/claim-ttl-minutes a claim not renewed for this long ends (default 30) :compose/orphan-ttl-minutes idle minutes before the reaper acts on a section whose last claim ended, when shorter than its TTL (default 10) :compose/program-grace-ms how long a host program is watched after its start; one that exits within it is reported :exited with its code and log tail (default 3000)

Addon config -> Settings. Pure: the profiles file's contents and the home
directory arrive as values.

Config keys (manifest `:addon/config`, then config.edn `:addons {"hive.compose" {..}}`):
  :compose/profiles             [Profile ..] or {id Profile}, inline
  :compose/profiles-file        EDN file of the same shape
                                (default ~/.config/hive-mcp/compose-profiles.edn)
  :compose/projects             {id Project}: compose projects whose services
                                and native profiles are addressable as targets
                                (`<project>/<target>`)
  :compose/default-ttl-minutes  idle minutes before the reaper acts (default 60)
  :compose/default-idle-action  :stop | :down | :none (default :stop)
  :compose/tick-seconds         reaper period (default 60)
  :compose/state-file           default ~/.local/state/hive-compose/state.edn
  :compose/timeout-ms           per compose call (default 60000)
  :compose/up-timeout-ms        per `up`, pulls included (default 600000)
  :compose/adopt?               adopt running stacks of configured profiles (default true)
  :compose/swarm?               count agents working in a project's directories as
                                use of its sections (default true)
  :compose/notify?              shout nREPL routes and reaps to the swarm (default true)
  :compose/activity             #{:nrepl :published}: which new connections count as
                                use; :published (the host ports containers publish:
                                a browser, any host-side client) is opt-in (default
                                #{:nrepl}). A project overrides it for its sections
                                with :project/activity, a preset with
                                :profile/activity. Connections from the project's
                                own containers never count.
  :compose/claim-ttl-minutes    a claim not renewed for this long ends (default 30)
  :compose/orphan-ttl-minutes   idle minutes before the reaper acts on a section
                                whose last claim ended, when shorter than its TTL
                                (default 10)
  :compose/program-grace-ms     how long a host program is watched after its
                                start; one that exits within it is reported
                                :exited with its code and log tail (default 3000)
raw docstring

activity-setclj

(activity-set v)

A configured activity (a set, or a list of keywords or names, as JSON gives) as a set of keywords; a value that is no collection stays as is, for the schema to refuse.

A configured activity (a set, or a list of keywords or names, as JSON
gives) as a set of keywords; a value that is no collection stays as is,
for the schema to refuse.
sourceraw docstring

default-log-dirclj

source

default-profiles-fileclj

source

default-state-fileclj

source

defaultsclj

source

expand-homeclj

(expand-home home s)

s with a leading ~ replaced by home.

`s` with a leading ~ replaced by `home`.
sourceraw docstring

normalize-profileclj

(normalize-profile home p)

Profile with a string id, its dir expanded against home and its programs resolved against that dir.

Profile with a string id, its dir expanded against `home` and its programs
resolved against that dir.
sourceraw docstring

normalize-programsclj

(normalize-programs home base programs)

Programs with string ids and their dirs made absolute against base, the directory of the project or profile that declares them.

Programs with string ids and their dirs made absolute against `base`, the
directory of the project or profile that declares them.
sourceraw docstring

normalize-projectclj

(normalize-project home p)

Project with a string id, its dir expanded against home and its programs resolved against that dir.

Project with a string id, its dir expanded against `home` and its programs
resolved against that dir.
sourceraw docstring

profiles-fileclj

(profiles-file cfg home)

Path of the profiles file cfg names, expanded against home.

Path of the profiles file `cfg` names, expanded against `home`.
sourceraw docstring

settingsclj

(settings cfg file-profiles home)

Result<Settings> from merged addon config cfg, the profiles read from the profiles file (file-profiles, nil when absent) and home. Inline profiles override file profiles with the same id.

Result<Settings> from merged addon config `cfg`, the profiles read from the
profiles file (`file-profiles`, nil when absent) and `home`. Inline profiles
override file profiles with the same id.
sourceraw docstring

settings-diffclj

(settings-diff old new)

What differs between Settings old and new: projects and profiles by id, other settings by key, and among those the ones a reload cannot apply (:restart-required). Pure.

What differs between Settings `old` and `new`: projects and profiles by id,
other settings by key, and among those the ones a reload cannot apply
(`:restart-required`). Pure.
sourceraw docstring

underclj

(under home base dir)

dir as an absolute path: itself when absolute or under ~, else resolved against base.

`dir` as an absolute path: itself when absolute or under ~, else resolved
against `base`.
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