User guide
September 13, 2026 · View on GitHub
First development session
- Quickstart: install → create → run → edit the home page → add pages → add components.
- Page development: ordinary Pages, ViewModels, dependency injection, and page lifecycle.
- Settings and localization: persistence, recovery, themes, and live language switching.
Add capabilities as needed
| Capability | Guide |
|---|---|
| SQLite and data access | SQLite |
| Tray icon, menus, and notifications | System tray |
| Update checks and installation | App updates |
Use xamlnexus recipes to inspect available components and xamlnexus list for installed modules. Settings installation is covered in the quickstart; editorconfig adds editor configuration.
Common commands
See the command reference for all options, defaults, supported combinations, and exit codes.
| Task | Example |
|---|---|
| Create a default project | xamlnexus new MyApp |
| Run for development | xamlnexus run |
| Add an ordinary page | xamlnexus page add Orders |
| Add a capability | xamlnexus add sqlite |
| Preview component removal | xamlnexus remove sqlite --dry-run |
| Preview a component update | xamlnexus update sqlite --dry-run |
| Preview a scaffold upgrade | xamlnexus upgrade --dry-run |
| Validate the project | xamlnexus validate |
| Diagnose the environment and integration | xamlnexus doctor |
| Read help | xamlnexus --help |
Run project commands inside the generated project, or supply --project. Development running currently uses Debug/x64/unpackaged mode, without watch or hot reload.
Maintenance and distribution
-
PR workflows and check settings: triggers, merge requirements, and how to enable, disable, or customize checks.
-
Change previews and JSON output: inspect automatic changes before applying them.
-
Project upgrades: distinguish component
updatefrom scaffoldupgrade, and handle local changes and conflicts. -
Diagnostics: investigate SDK, project reference, and integration problems.
-
Generated-project release instructions: prepare installers, signing, and update assets. Use your generated project's own
RELEASING.mdandeng/publishing/release.jsonwhen publishing.
All generated source and configuration can be customized. Content differences produce warnings; automatic removal or upgrades stop with a conflict when they cannot protect user changes. See the product model.