The compose engine port. Every method answers a Result.
The compose engine port. Every method answers a Result.
(-profiles e profile)Result<#{name}>: native compose profiles declared by the profile's project.
Result<#{name}>: native compose profiles declared by the profile's project.
(-projects e)Result<[{:name :status :config-files}]>: every compose project on the host.
Result<[{:name :status :config-files}]>: every compose project on the host.
(-up! e profile services)Result<{:out}>: start services detached. An empty services is a no-op.
Result<{:out}>: start `services` detached. An empty `services` is a no-op.
(-listed e profile)Result<[service]>: services enabled for profile: the always-on ones plus those of its native compose profiles.
Result<[service]>: services enabled for `profile`: the always-on ones plus those of its native compose profiles.
(-version e)Result<string>: the engine's version, or why it is unavailable.
Result<string>: the engine's version, or why it is unavailable.
(-logs e profile services tail)Result<{:out}>: the last tail log lines of services (all when empty).
Result<{:out}>: the last `tail` log lines of `services` (all when empty).
(-running e profile)Result<#{service}>: services of the profile's project whose containers are running.
Result<#{service}>: services of the profile's project whose containers are running.
(-stop! e profile services)Result<{:out}>: stop services, keeping containers and volumes. Empty is a no-op.
Result<{:out}>: stop `services`, keeping containers and volumes. Empty is a no-op.
(-down! e profile services)Result<{:out}>: remove the containers of services, never volumes. Empty is a no-op.
Result<{:out}>: remove the containers of `services`, never volumes. Empty is a no-op.
(-closure e profile)Result<[service]>: the services profile needs, its depends_on closure included.
Result<[service]>: the services `profile` needs, its depends_on closure included.
Host programs: the processes a section runs outside compose.
Host programs: the processes a section runs outside compose.
(-alive? r pid)True while the process pid lives.
True while the process `pid` lives.
(-facts r dir)Result<{file-name parsed}>: the build files of dir (shadow-cljs.edn, deps.edn, bb.edn as EDN; project.clj as true).
Result<{file-name parsed}>: the build files of `dir` (shadow-cljs.edn, deps.edn, bb.edn as EDN; project.clj as true).
(-halt! r pid)Result<{:pid :stopped?}>: terminate the process group pid leads. Halting a dead pid succeeds.
Result<{:pid :stopped?}>: terminate the process group `pid` leads. Halting a dead pid succeeds.
(-listening? r port)True when something accepts connections on local port.
True when something accepts connections on local `port`.
(-nrepl-port r dir)The port in dir's .nrepl-port file, nil when absent.
The port in `dir`'s .nrepl-port file, nil when absent.
(-start! r program log)Result<{:pid}>: start resolved program detached, leading its own process group, output appended to log.
Result<{:pid}>: start resolved `program` detached, leading its own process group, output appended to `log`.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |