Liking cljdoc? Tell your friends :D

hive-compose.promote.env

Pure: an environment is {name value}, a value either a string or a secret reference, a one-entry map naming its scheme: {:pass "<store path>"}.

A reference is read from its store only when a process is spawned (see hive-compose.adapter.secrets). Everything else, a compose query, an error, a rendered surface, sees it as its rendering <scheme>:<path>, never the value it stands for.

Pure: an environment is {name value}, a value either a string or a secret
reference, a one-entry map naming its scheme: `{:pass "<store path>"}`.

A reference is read from its store only when a process is spawned (see
`hive-compose.adapter.secrets`). Everything else, a compose query, an error,
a rendered surface, sees it as its rendering `<scheme>:<path>`, never the
value it stands for.
raw docstring

from-paramclj

(from-param v)

An env value as sent over MCP: an object {"pass" path} is a reference, anything else its string.

An env value as sent over MCP: an object {"pass" path} is a reference,
anything else its string.
sourceraw docstring

pathclj

(path ref)

Where in its store reference ref points.

Where in its store reference `ref` points.
sourceraw docstring

ref?clj

(ref? v)

True when v is a secret reference: a one-entry map of a keyword scheme to a string.

True when `v` is a secret reference: a one-entry map of a keyword scheme to
a string.
sourceraw docstring

refsclj

(refs env)

{name ref} of the references in env.

{name ref} of the references in `env`.
sourceraw docstring

renderclj

(render ref)

ref as <scheme>:<path>, the only form a reference is shown in.

`ref` as `<scheme>:<path>`, the only form a reference is shown in.
sourceraw docstring

renderedclj

(rendered env)

env with every reference replaced by its rendering. What a process that creates nothing (a compose query, stop, down) is given: interpolation still finds every variable, and no secret is read.

`env` with every reference replaced by its rendering. What a process that
creates nothing (a compose query, stop, down) is given: interpolation still
finds every variable, and no secret is read.
sourceraw docstring

schemeclj

(scheme ref)

The scheme of reference ref: :pass.

The scheme of reference `ref`: :pass.
sourceraw docstring

scrubclj

(scrub env resolved s)

s with every value a reference of env resolved to (resolved is the spawned environment) replaced by the reference's rendering, so a process echoing its environment does not carry a secret into a result.

`s` with every value a reference of `env` resolved to (`resolved` is the
spawned environment) replaced by the reference's rendering, so a process
echoing its environment does not carry a secret into a result.
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