Skip to content

Configuration

Kyushu works out of the box. Each command uses defaults but supports its own optional config file to override them.

The build config typically lives on your local machine and in CI, while the run config lives where you serve your worker.

Controls how kyu build bundles and pre-initializes your worker.

FieldTypeDefaultDescription
entrystringsrc/index.tsPath to your TypeScript or JavaScript entry point
outdirstringworkerOutput directory for the built worker
outfilestring__kyushu_worker.wasmOutput filename for the built worker
kyushu.build.toml
entry = "src/server.ts"
outdir = "dist"

Controls how kyu run loads and serves your worker.

FieldTypeDefaultDescription
worker.wasmstringworker/__kyushu_worker.wasmPath to the built worker .wasm file
worker.portnumber5987Port to listen on
mountsarrayFilesystem mounts to expose to the worker
mounts[].hoststringPath on the host filesystem
mounts[].gueststringPath inside the worker sandbox
mounts[].writableboolfalseWhether the mount is writable (defaults to read-only)
envarrayEnvironment variables to expose to the worker
env[].keystringEnvironment variable name
env[].valuestringEnvironment variable value
kyushu.run.toml
[worker]
wasm = "build/__custom_kyushu_worker.wasm"
port = 8080
[[mounts]]
host = "./public"
guest = "/public"
[[mounts]]
host = "./data"
guest = "/data"
writable = true
[[env]]
key = "API_KEY"
value = "secret"