Configuration

mygo.config.ts, at the root of a project, describes the app and how the CLI develops and builds it. Its default export is the configuration, typed by defineConfig from the mygo-cli package that projects depend on, so editors complete and document every field:

import { defineConfig } from "mygo-cli";

export default defineConfig({
  name: "My App",
  slug: "my-app",
  identifier: "com.example.myapp",
  version: "1.2.0",
  copyright: "© 2026 Example Inc.",

  devUrl: "http://localhost:5173",
  devCommand: "bun run dev:web",
  buildCommand: "bun run build:web",
  frontendDist: "dist",
  bindings: "src/mygo.ts",
  out: "build",

  resources: ["third_party/licenses"],
  urlSchemes: ["myapp"],
  fileAssociations: [{ ext: ["md"], name: "Markdown Document", mimeType: "text/markdown" }],

  i18n: { dir: "locales", source: "en" },
  updates: { publicKey: "…", github: "you/my-app" },
  macos: { signingIdentity: "Developer ID Application: Jane Doe (TEAMID)" },
  windows: { certificate: "certs/code-signing.pfx" },
  linux: { maintainer: "Jane Doe <jane@example.com>" },
});

Every field is optional. The configuration can also be JSON, in mygo.json, as projects of native UI have it: they have no JavaScript, and no frontend to develop or build, so they leave out the fields of the frontend.

The app

Development and the frontend

See the frontend for how they fit together. New projects set out to build, apart from Vite's dist.

Integration

Each file association has:

i18n

The catalogs of the app's messages, a JSON file per language; see Languages. Without i18n, the app ships English only.

updates

Signed auto-updates. publicKey and one of github and url are required.

macos

See macOS.

windows

See Windows.

linux

See Linux.

Computed configuration

The configuration is code, so it can compute fields: read the version from package.json, or a signing identity from the environment of CI. The default export may also be a function, which can be async, of the command running ("dev", "build", "generate" or "init"):

import { defineConfig } from "mygo-cli";
import pkg from "./package.json" with { type: "json" };

export default defineConfig(({ command }) => ({
  name: command === "dev" ? "My App (dev)" : "My App",
  version: pkg.version,
  macos: {
    signingIdentity: process.env.MACOS_SIGNING_IDENTITY ?? "-",
  },
}));

How it runs

The CLI evaluates mygo.config.ts with Bun, or else Node.js 22.6 or later, in the project directory, and checks the result. Node.js runs TypeScript by removing the types, so the file may use type annotations but not syntax that generates code, such as enum. What the file prints goes to the terminal, apart from the CLI's output. mygo dev reloads the app when the file changes, but not when files it imports do.

mygo.json

The configuration can be JSON instead, in mygo.json, which needs no JavaScript runtime to read; mygo init -template native makes one:

{
  "name": "My App",
  "identifier": "com.example.myapp",
  "devUrl": "http://localhost:5173",
  "macos": { "signingIdentity": "Developer ID Application: Jane Doe (TEAMID)" }
}

It has the same fields. A project has either mygo.config.ts or mygo.json, not both.