Skip to content
Interfaceseedcordv0.22.0

SeedcordConfig

The seedcord.config.ts of a bot that runs on Cloudflare Workers. A bot that runs on node or bun uses SeedcordServerConfig. Its build also takes outDir and start.

interface SeedcordConfig

files

Folders whose non-code files seedcord build bundles for readFiles to read, like ['./locales']. Each one includes its subfolders and resolves against root. A folder can sit beside root, like '../assets' with root: './src', as long as it is inside the folder that holds this config.

files?: string[]

Default:[]

idleAnimation

Runs any always-on animations in seedcord dev.

idleAnimation?: boolean

Default:true

instance

Path to the module whose default export is a configured Seedcord instance.

instance: string;

port

The port seedcord dev serves the worker's interactions endpoint on. 0 picks a free port on each run. A tunnel URL needs a fixed port.

port?: number

Default:3000

root

Root directory used for resolving relative paths.

root?: string

Default:the config directory

tunnel

How seedcord dev exposes an http bot's interactions server. This has no effect on a gateway bot.

true opens a cloudflared quick tunnel and writes the interactions endpoint on every run, since the hostname changes each time. An https URL is one you already serve, through a named cloudflared tunnel, a tailscale funnel, or any reverse proxy. The CLI checks that URL reaches this process, writes the endpoint when the stored value differs, and leaves it in place.

tunnel?: boolean | string

Default:true

vitePlugins

A function that returns the Vite plugins to run on your bot's code in every seedcord command that loads it, like () => [yaml()]. They change what an import loads, like turning a .yaml file into an object. seedcord calls it once for each Vite server and build.

vitePlugins?: () => PluginOption[]