Skip to main content

kog.config.ts

Project-level configuration (kog.config.ts, or kog.config.js in a JavaScript project). Everything has a sensible default; a fresh project's config is nearly empty.

import { defineConfig } from 'kog';

export default defineConfig({
// Entry point (default: auto-detected — src/App.tsx, src/App.jsx, or src/App.js)
entry: 'src/App.tsx',

// Board slug: 'cyd' | 'cyd-classic' | 'waveshare-1.46b' | 'waveshare-amoled-2.06'.
// Sets the simulator's size, HiDPI scale, and display shape. (kog flash picks the
// board from the chip, its flash size and --board, not from here.)
board: 'waveshare-1.46b',

simulator: {
// Display size for board-less development (used only when `board` is unset)
width: 320,
height: 240,
},

dev: {
port: 8632, // dev-server port
},

ota: {
// Path to your Ed25519 signing key for release bundles
// (unset: kog deploy ships unsigned bundles, which keyless dev boards accept)
signingKey: process.env.KOG_SIGNING_KEY,
},
});
note

The full option surface will grow with the toolchain; options documented here are stable. Unknown top-level keys (and unknown keys under network) are an error, not silently ignored; keys inside the other blocks aren't checked yet. The config also accepts simulator.zoom, dev.wireless, and build.codeSplit, which are reserved and have no effect yet. Wi-Fi credentials go under network.wifi; see Wi-Fi.