Liking cljdoc? Tell your friends :D

bsdkrun.args

Builds the bsdkrun argv (minus the binary and global flags) for a detached create. Every path ends with -d so create! always yields a handle.

Options are a plain map with keyword keys mirroring the other SDKs' create-options shape, discriminated on :os. Mirrors sdk/ruby/lib/bsdkrun/args.rb 1:1.

Builds the `bsdkrun` argv (minus the binary and global flags) for a
detached `create`. Every path ends with `-d` so `create!` always yields a
handle.

Options are a plain map with keyword keys mirroring the other SDKs'
create-options shape, discriminated on `:os`. Mirrors
`sdk/ruby/lib/bsdkrun/args.rb` 1:1.
raw docstring

build-create-argsclj

(build-create-args opts)

Build the full detached create argv for the given options.

opts is a map discriminated on :os (a keyword, or the equivalent string — :linux, :freebsd, :netbsd, :firmware, :kernel, :unikraft, :nanos, :osv).

Throws errors/unknown-os on an unrecognized :os.

Build the full detached `create` argv for the given options.

`opts` is a map discriminated on `:os` (a keyword, or the equivalent
string — `:linux`, `:freebsd`, `:netbsd`, `:firmware`, `:kernel`,
`:unikraft`, `:nanos`, `:osv`).

Throws `errors/unknown-os` on an unrecognized `:os`.
sourceraw docstring

disk-argsclj

(disk-args o)

Disk-persistence flags shared by BSD / firmware / kernel guests.

Disk-persistence flags shared by BSD / firmware / kernel guests.
sourceraw docstring

firmware-argsclj

(firmware-args opts)
source

freebsd-argsclj

(freebsd-args opts)
source

kernel-argsclj

(kernel-args opts)
source

linux-argsclj

(linux-args opts)
source

name-argsclj

(name-args o)

--name flag if a name is set.

`--name` flag if a name is set.
sourceraw docstring

nanos-argsclj

(nanos-args opts)

Nanos: no agent (like unikraft), but it has a root disk, so :persist is honored. :image is a path or a ~/.ops/images name.

Nanos: no agent (like unikraft), but it has a root disk, so `:persist` is
honored. `:image` is a path or a `~/.ops/images` name.
sourceraw docstring

net-argsclj

(net-args net)

Networking flags shared by every guest kind.

Networking flags shared by every guest kind.
sourceraw docstring

netbsd-argsclj

(netbsd-args opts)
source

osv-argsclj

(osv-args opts)

OSv: like nanos, no agent (no exec/shell/snapshot), but it does have a root filesystem, so :persist is honored. :image is a loader.img, or on x86_64 the loader ELF plus a :disk.

OSv: like nanos, no agent (no exec/shell/snapshot), but it does have a
root filesystem, so `:persist` is honored. `:image` is a loader.img, or on
x86_64 the loader ELF plus a `:disk`.
sourceraw docstring

unikraft-argsclj

(unikraft-args opts)

No disk-args: a unikernel has no disk, so there is nothing to persist, attach or clone. :path is a kraft project dir or an image; default .. Volumes are the exception to "no disk options": virtio-fs shares, which need neither a disk nor an agent.

No `disk-args`: a unikernel has no disk, so there is nothing to persist,
attach or clone. `:path` is a kraft project dir or an image; default `.`.
Volumes are the exception to "no disk options": virtio-fs shares, which
need neither a disk nor an agent.
sourceraw docstring

vm-argsclj

(vm-args o)

--cpus / --mem sizing flags.

`--cpus` / `--mem` sizing flags.
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