Set up the toolchain, build Dub.app, and run the same checks CI runs.
Dub is a Rust engine in crates/ and a SwiftUI and AppKit app in
apple/Dub/. You build both on a Mac.
Prerequisites
Xcode (the bootstrap script asks for Xcode 15 or later).
Rust through rustup. The repo pins its toolchain in
rust-toolchain.toml (with both the Apple Silicon and Intel targets), so
you build with the same Rust as CI.
XcodeGen:
brew install xcodegen. The Xcode project is generated from
apple/project.yml and isn’t checked in.
Optional: cargo-nextest makes the test suite faster, and cargo-deny runs
the licence check. The Makefile falls back or skips without them.
bootstrap.sh installs the git hooks, builds the Rust core into
DubCore.xcframework, generates the Swift bindings, and generates
apple/Dub.xcodeproj. Run it again after apple/project.yml or
crates/dub-ffi/src/lib.rs changes.make app builds a Debug app to
apple/build/Build/Products/Debug/Dub.app, rebuilding the Rust core only when
Rust sources changed.
Command
Does
make app
Debug build.
make app APP_CONFIG=Release or make app-release
Release build.
make run-app
Build, quit any running Dub, and launch the new one.
make dist
Universal Release build, zipped with its SHA-256 in dist/.
Run the checks
make test # cargo nextest run --workspace + clippy -D warningsmake ci # docs-check + deny + fmt-check + clippy + test
make ci is exactly what CI runs. docs-check fails when a number in the
docs, such as the FFI version, no longer matches the code. deny checks every
dependency’s licence: Dub is MIT OR Apache-2.0 and takes no GPL or LGPL
dependencies.make snapshot runs the Swift snapshot tests. CI has no macOS app job, so
those run only on your machine. Change a view, re-record its baseline in the
same change.
The pre-push hook
bootstrap.sh (or make hooks) points git at .githooks/. Before every
push it runs:
cargo fmt --check
cargo clippy with warnings as errors
check-docs
the Rust test suite
the Swift snapshot suite, when xcodebuild is present
A red gate blocks the push. DUB_PREPUSH_TESTS=0 skips the tests and
DUB_PREPUSH_SNAPSHOT=0 skips the snapshots; git push --no-verify skips
the hook once.
If the test suite suddenly crawls, count the build artifacts:
ls target/debug/deps | wc -l. Tens of thousands of files make every test
process slow to start. make sweep removes artifacts unused for 14 days
without forcing a rebuild.
Before you open a PR
Read AGENTS.md: the
repo’s conventions, in one page.
Write the failing test first. Audio-path code needs assert_no_alloc
coverage.
Branches are feat/, fix/, chore/, refactor/, docs/ or test/;
commits are conventional (fix(timecode): …); one concern per PR, with a
Test plan section.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Dub","description":"Timecode vinyl for scratch DJs and sound systems. The manual for Dub, the open-source DVS for macOS.","colors":{"primary":"#A8752F","light":"#D9A33A","dark":"#C49157"},"logo":{"light":"https://mintcdn.com/dub-3ccc829c/yjsJ2nZv-7OeAFUs/logo/light.svg?fit=max\u0026auto=format\u0026n=yjsJ2nZv-7OeAFUs\u0026q=85\u0026s=c66e63054545147233df8bceb8bf885d","dark":"https://mintcdn.com/dub-3ccc829c/yjsJ2nZv-7OeAFUs/logo/dark.svg?fit=max\u0026auto=format\u0026n=yjsJ2nZv-7OeAFUs\u0026q=85\u0026s=9de389f24e6e3bee1432836b0a806ae1"},"favicon":"https://mintcdn.com/dub-3ccc829c/yjsJ2nZv-7OeAFUs/favicon.png?fit=max\u0026auto=format\u0026n=yjsJ2nZv-7OeAFUs\u0026q=85\u0026s=822c249106c922f25eace67503dac857","appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://github.com/kLOsk/dub/issues","label":"Report a bug"}],"primary":{"type":"github","href":"https://github.com/kLOsk/dub"}},"footer":{"socials":{"github":"https://github.com/kLOsk/dub"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Download","icon":"download","href":"https://github.com/kLOsk/dub/releases/latest"},{"anchor":"Source on GitHub","icon":"github","href":"https://github.com/kLOsk/dub"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dub-3ccc829c","hasAudioNarration":false,"actualSubdomain":"dub-3ccc829c","customDomains":[],"gitSource":{"type":"github","owner":"klosk","repo":"dub","deployBranch":"main","contentDirectory":"site","isPrivate":false,"mountPath":"","label":"","_id":"6afaf4dbdd50ae575c5bef20"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afd6d63801696bcb625221d","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Manual","count":16},{"language":"default","tag":"Developers","count":6},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Library","count":4},{"language":"default","tag":"Playing","count":3},{"language":"default","tag":"Settings","count":2},{"language":"default","tag":"Prep and records","count":2},{"language":"default","tag":"Help","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developers/build","slug":"/developers/build","pageMetadata":{"title":"Build from source","description":"Set up the toolchain, build Dub.app, and run the same checks CI runs.","icon":"hammer","href":"/developers/build"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Set up the toolchain, build Dub.app, and run the same checks CI runs.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Dub is a Rust engine in `,_jsx(_components.code,{children:`crates/`}),` and a SwiftUI and AppKit app in\n`,_jsx(_components.code,{children:`apple/Dub/`}),`. You build both on a Mac.`]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Xcode`}),` (the bootstrap script asks for Xcode 15 or later).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Rust`}),` through `,_jsx(_components.a,{href:`https://rustup.rs`,children:`rustup`}),`. The repo pins its toolchain in\n`,_jsx(_components.code,{children:`rust-toolchain.toml`}),` (with both the Apple Silicon and Intel targets), so\nyou build with the same Rust as CI.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`https://github.com/yonaskolb/XcodeGen`,children:`XcodeGen`})}),`:\n`,_jsx(_components.code,{children:`brew install xcodegen`}),`. The Xcode project is generated from\n`,_jsx(_components.code,{children:`apple/project.yml`}),` and isn’t checked in.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Optional: `,_jsx(_components.code,{children:`cargo-nextest`}),` makes the test suite faster, and `,_jsx(_components.code,{children:`cargo-deny`}),` runs\nthe licence check. The Makefile falls back or skips without them.`]}),`\n`,_jsx(Heading,{level:`2`,id:`build-the-app`,children:`Build the app`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`git`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` clone`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://github.com/kLOsk/dub.git`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \u0026\u0026 `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`cd`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` dub`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`./scripts/bootstrap.sh`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # one-time: bindings + Xcode project`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`make`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` app`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`bootstrap.sh`}),` installs the git hooks, builds the Rust core into\n`,_jsx(_components.code,{children:`DubCore.xcframework`}),`, generates the Swift bindings, and generates\n`,_jsx(_components.code,{children:`apple/Dub.xcodeproj`}),`. Run it again after `,_jsx(_components.code,{children:`apple/project.yml`}),` or\n`,_jsx(_components.code,{children:`crates/dub-ffi/src/lib.rs`}),` changes.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`make app`}),` builds a Debug app to\n`,_jsx(_components.code,{children:`apple/build/Build/Products/Debug/Dub.app`}),`, rebuilding the Rust core only when\nRust sources changed.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Does`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`make app`})}),_jsx(_components.td,{children:`Debug build.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`make app APP_CONFIG=Release`}),` or `,_jsx(_components.code,{children:`make app-release`})]}),_jsx(_components.td,{children:`Release build.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`make run-app`})}),_jsx(_components.td,{children:`Build, quit any running Dub, and launch the new one.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`make dist`})}),_jsxs(_components.td,{children:[`Universal Release build, zipped with its SHA-256 in `,_jsx(_components.code,{children:`dist/`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`run-the-checks`,children:`Run the checks`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`make`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` test`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # cargo nextest run --workspace + clippy -D warnings`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`make`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ci`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # docs-check + deny + fmt-check + clippy + test`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`make ci`}),` is exactly what CI runs. `,_jsx(_components.code,{children:`docs-check`}),` fails when a number in the\ndocs, such as the FFI version, no longer matches the code. `,_jsx(_components.code,{children:`deny`}),` checks every\ndependency’s licence: Dub is MIT OR Apache-2.0 and takes no GPL or LGPL\ndependencies.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`make snapshot`}),` runs the Swift snapshot tests. CI has no macOS app job, so\nthose run only on your machine. Change a view, re-record its baseline in the\nsame change.`]}),`\n`,_jsx(Heading,{level:`2`,id:`the-pre-push-hook`,children:`The pre-push hook`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`bootstrap.sh`}),` (or `,_jsx(_components.code,{children:`make hooks`}),`) points git at `,_jsx(_components.code,{children:`.githooks/`}),`. Before every\npush it runs:`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cargo fmt --check`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`cargo clippy`}),` with warnings as errors`]}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`check-docs`})}),`\n`,_jsx(_components.li,{children:`the Rust test suite`}),`\n`,_jsxs(_components.li,{children:[`the Swift snapshot suite, when `,_jsx(_components.code,{children:`xcodebuild`}),` is present`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`A red gate blocks the push. `,_jsx(_components.code,{children:`DUB_PREPUSH_TESTS=0`}),` skips the tests and\n`,_jsx(_components.code,{children:`DUB_PREPUSH_SNAPSHOT=0`}),` skips the snapshots; `,_jsx(_components.code,{children:`git push --no-verify`}),` skips\nthe hook once.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`If the test suite suddenly crawls, count the build artifacts:\n`,_jsx(_components.code,{children:`ls target/debug/deps | wc -l`}),`. Tens of thousands of files make every test\nprocess slow to start. `,_jsx(_components.code,{children:`make sweep`}),` removes artifacts unused for 14 days\nwithout forcing a rebuild.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`before-you-open-a-pr`,children:`Before you open a PR`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Read `,_jsx(_components.a,{href:`https://github.com/kLOsk/dub/blob/main/AGENTS.md`,children:_jsx(_components.code,{children:`AGENTS.md`})}),`: the\nrepo’s conventions, in one page.`]}),`\n`,_jsxs(_components.li,{children:[`Write the failing test first. Audio-path code needs `,_jsx(_components.code,{children:`assert_no_alloc`}),`\ncoverage.`]}),`\n`,_jsxs(_components.li,{children:[`Branches are `,_jsx(_components.code,{children:`feat/`}),`, `,_jsx(_components.code,{children:`fix/`}),`, `,_jsx(_components.code,{children:`chore/`}),`, `,_jsx(_components.code,{children:`refactor/`}),`, `,_jsx(_components.code,{children:`docs/`}),` or `,_jsx(_components.code,{children:`test/`}),`;\ncommits are conventional (`,_jsx(_components.code,{children:`fix(timecode): …`}),`); one concern per PR, with a\n`,_jsx(_components.strong,{children:`Test plan`}),` section.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Build from source","description":"Set up the toolchain, build Dub.app, and run the same checks CI runs.","icon":"hammer","href":"/developers/build"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Build the app","slug":"build-the-app","depth":2,"children":[]},{"title":"Run the checks","slug":"run-the-checks","depth":2,"children":[]},{"title":"The pre-push hook","slug":"the-pre-push-hook","depth":2,"children":[]},{"title":"Before you open a PR","slug":"before-you-open-a-pr","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"dub-3ccc829c","siteName":"Dub","title":"Build from source - Dub","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T18:13:10.314Z","originalFileLocation":"developers/build.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Set up the toolchain, build Dub.app, and run the same checks CI runs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Build from source - Dub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Set up the toolchain, build Dub.app, and run the same checks CI runs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dub-3ccc829c.mintlify.app/developers/build\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dub-3ccc829c.mintlify.site/_mintlify/api/og/v2?division=Developers\u0026amp;title=Build+from+source\u0026amp;description=Set+up+the+toolchain%2C+build+Dub.app%2C+and+run+the+same+checks+CI+runs.\u0026amp;theme=958ea07cad40b39620a45bca\u0026amp;signature=abfb7e0f92623c3e9acb21dd9fcb168148491ec6368a7035c1f831642f318bdf\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Build from source - Dub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Set up the toolchain, build Dub.app, and run the same checks CI runs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dub-3ccc829c.mintlify.site/_mintlify/api/og/v2?division=Developers\u0026amp;title=Build+from+source\u0026amp;description=Set+up+the+toolchain%2C+build+Dub.app%2C+and+run+the+same+checks+CI+runs.\u0026amp;theme=958ea07cad40b39620a45bca\u0026amp;signature=abfb7e0f92623c3e9acb21dd9fcb168148491ec6368a7035c1f831642f318bdf\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dub-3ccc829c/rHdSH-e6JXq9G7cR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A8752F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dub-3ccc829c.mintlify.app/developers/build\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/build.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dub-3ccc829c.mintlify.app/#organization\",\"name\":\"Dub\",\"url\":\"https://dub-3ccc829c.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dub-3ccc829c/yjsJ2nZv-7OeAFUs/logo/light.svg?fit=max\u0026auto=format\u0026n=yjsJ2nZv-7OeAFUs\u0026q=85\u0026s=c66e63054545147233df8bceb8bf885d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dub-3ccc829c.mintlify.app#website\",\"name\":\"Dub\",\"url\":\"https://dub-3ccc829c.mintlify.app\",\"publisher\":{\"@id\":\"https://dub-3ccc829c.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dub-3ccc829c.mintlify.app/developers/build#webpage\",\"url\":\"https://dub-3ccc829c.mintlify.app/developers/build\",\"name\":\"Build from source\",\"description\":\"Set up the toolchain, build Dub.app, and run the same checks CI runs.\",\"dateModified\":\"2026-11-16T18:13:10.314Z\",\"isPartOf\":{\"@id\":\"https://dub-3ccc829c.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://dub-3ccc829c.mintlify.app/developers/build#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dub-3ccc829c.mintlify.app/developers/build#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dub\",\"item\":\"https://dub-3ccc829c.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Build from source\",\"item\":\"https://dub-3ccc829c.mintlify.app/developers/build\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://dub-3ccc829c.mintlify.app/developers/build#article\",\"headline\":\"Build from source\",\"name\":\"Build from source\",\"description\":\"Set up the toolchain, build Dub.app, and run the same checks CI runs.\",\"url\":\"https://dub-3ccc829c.mintlify.app/developers/build\",\"mainEntityOfPage\":{\"@id\":\"https://dub-3ccc829c.mintlify.app/developers/build#webpage\"},\"dateModified\":\"2026-11-16T18:13:10.314Z\",\"publisher\":{\"@id\":\"https://dub-3ccc829c.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://dub-3ccc829c.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dub\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Dub\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/build.md","siteName":"Dub","nav":{"global":{"anchors":[{"anchor":"Download","icon":"download","href":"https://github.com/kLOsk/dub/releases/latest"},{"anchor":"Source on GitHub","icon":"github","href":"https://github.com/kLOsk/dub"}]},"tabs":[{"tab":"Manual","pages":[{"title":"Manual","href":""}]},{"tab":"Developers","groups":[{"group":"Developers","pages":[{"title":"Build from source","icon":"hammer","href":"/developers/build"},{"title":"The dub CLI","description":"The headless dub binary: test the engine, inspect timecode, rip records and move your library from the terminal.","icon":"terminal","href":"/developers/cli"},{"title":"How Dub is built","icon":"sitemap","href":"/developers/architecture"}]}]}]},"basePath":"","title":"Build from source - Dub","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}