ContainerShorthand

Defined in: packages/runtime/src/container/types.ts:643

Flat option bag for the shorthand create(image, opts) / run(image, opts) path.

Remarks

Mirrors the most common docker run flags; translated into a ContainerSpec by shorthandToSpec(). Prefer this over hand-building a spec for typical cases.

Properties

allow?

readonly optional allow?: Partial<NamespacePermissions>

Defined in: packages/runtime/src/container/types.ts:671

Namespace permissions override (e.g. mount policy).

---

argv?

readonly optional argv?: readonly string[]

Defined in: packages/runtime/src/container/types.ts:649

Argv for PID 1.

---

audit?

readonly optional audit?: boolean

Defined in: packages/runtime/src/container/types.ts:665

Enable kernel open() auditing for this container.

---

bin?

readonly optional bin?: string

Defined in: packages/runtime/src/container/types.ts:647

PID-1 bin; defaults to the image’s conventional init.

---

cwd?

readonly optional cwd?: string

Defined in: packages/runtime/src/container/types.ts:653

PID-1 working directory.

---

env?

readonly optional env?: Readonly<Record<string, string>>

Defined in: packages/runtime/src/container/types.ts:651

Env overrides layered over image env.

---

factotumScope?

readonly optional factotumScope?: readonly string[]

Defined in: packages/runtime/src/container/types.ts:673

Factotum credential scope — comma-separated domain patterns the child can auth to.

---

healthCheck?

readonly optional healthCheck?: HealthCheck

Defined in: packages/runtime/src/container/types.ts:675

M5-S4: Health check configuration.

---

isolateEnv?

readonly optional isolateEnv?: boolean

Defined in: packages/runtime/src/container/types.ts:669

rfork-style: isolate env (clean env, no parent inheritance)

---

isolateSrv?

readonly optional isolateSrv?: boolean

Defined in: packages/runtime/src/container/types.ts:667

rfork-style: isolate /srv (new empty srvFS)

---

logBufferSize?

readonly optional logBufferSize?: number

Defined in: packages/runtime/src/container/types.ts:663

Override the default log buffer size (bytes).

---

mounts?

readonly optional mounts?: Readonly<Record<string, MountSpec>>

Defined in: packages/runtime/src/container/types.ts:657

Extra mounts layered over image mounts.

---

name?

readonly optional name?: string

Defined in: packages/runtime/src/container/types.ts:645

Container name; auto-generated when omitted.

---

restart?

readonly optional restart?: RestartPolicy

Defined in: packages/runtime/src/container/types.ts:659

Restart policy — drives the manager’s restart supervisor.

---

rm?

readonly optional rm?: boolean

Defined in: packages/runtime/src/container/types.ts:661

Auto-remove on PID-1 exit (docker --rm).

---

tty?

readonly optional tty?: boolean

Defined in: packages/runtime/src/container/types.ts:655

Allocate a TTY on /dev/cons.