Skip to content
Back to search

native

Toolkit for building native desktop apps

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/vercel-labs-native/badge.svg)](/listings/vercel-labs-native)

HTML

<a href="/listings/vercel-labs-native"><img src="/api/listings/vercel-labs-native/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install the CLI with Node.js 24 or later:

npm install -g @native-sdk/cli

Create and run an app:

native init my_app
cd my_app
native dev

The generated project opens a counter app and includes:

- `src/core.ts`: the app's model, messages, and update function. - `src/app.native`: the view, with layout, bindings, and message dispatch. - `app.json`: app identity, windows, permissions, and security settings.

`native dev` watches markup changes and updates the view while preserving app state. TypeScript core changes rebuild and restart the app. Use `native dev --core` to exercise core logic under Node.js without opening a window, `native check` to validate the project, and `native build` to create a release binary.

The CLI uses a compatible Zig toolchain from your `PATH` or offers to download the pinned version. See [Quick Start](https://native-sdk.dev/docs/quick-start) for platform prerequisites and the complete workflow.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 78 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Native SDK
  2. <p>
  3. <a href="https://vercel.com/labs#active-experiments"><img alt="Vercel Labs Experiment" src="https://img.shields.io/badge/LABS-EXPERIMENT-0a0a0a.svg?style=for-the-badge&amp;logo=Vercel&amp;labelColor=000000" height="28"></a>
  4. <a href="https://www.npmjs.com/package/@native-sdk/cli"><img alt="npm version: @native-sdk/cli" src="https://img.shields.io/npm/v/%40native-sdk%2Fcli.svg?style=for-the-badge&amp;labelColor=000000" height="28"></a>
  5. <a href="https://github.com/vercel-labs/native/blob/main/LICENSE"><img alt="License: Apache-2.0" src="https://img.shields.io/github/license/vercel-labs/native.svg?style=for-the-badge&amp;labelColor=000000" height="28"></a>
  6. <a href="https://www.npmjs.com/package/@native-sdk/cli"><img alt="npm downloads per month: @native-sdk/cli" src="https://img.shields.io/npm/dm/%40native-sdk%2Fcli.svg?style=for-the-badge&amp;labelColor=000000&amp;label=npm%20downloads" height="28"></a>
  7. </p>
  8. Native SDK is a toolkit for building native desktop applications with TypeScript and Native markup. The toolkit compiles app logic and views into a native executable and renders the interface in OS windows. Zig cores and optional embedded web content are also supported.
  9. Native SDK is experimental. Platform capabilities vary, and mobile support is still evolving. See the [platform support matrix](https://native-sdk.dev/docs/platform-support) for current support.
  10. ## Quick start
  11. Install the CLI with Node.js 24 or later:
  12. ```bash
  13. npm install -g @native-sdk/cli
  14. ```
  15. Create and run an app:
  16. ```bash
  17. native init my_app
  18. cd my_app
  19. native dev
  20. ```
  21. The generated project opens a counter app and includes:
  22. - `src/core.ts`: the app's model, messages, and update function.
  23. - `src/app.native`: the view, with layout, bindings, and message dispatch.
  24. - `app.json`: app identity, windows, permissions, and security settings.
  25. `native dev` watches markup changes and updates the view while preserving app state. TypeScript core changes rebuild and restart the app. Use `native dev --core` to exercise core logic under Node.js without opening a window, `native check` to validate the project, and `native build` to create a release binary.
  26. The CLI uses a compatible Zig toolchain from your `PATH` or offers to download the pinned version. See [Quick Start](https://native-sdk.dev/docs/quick-start) for platform prerequisites and the complete workflow.
  27. ## App model
  28. Events dispatch typed messages to `update`, which returns the next model and any effects. The view derives its content from the model. Filesystem access, network requests, and other external work run through effects and TypeScript services.
  29. App cores use a checked TypeScript subset and compile to native code. To write a Zig core instead, create the project with `native init my_app --template zig-core`. See [App Model](https://native-sdk.dev/docs/app-model) and [TypeScript Cores](https://native-sdk.dev/docs/typescript).
  30. ## Examples
  31. <picture>
  32. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/soundboard-dark.webp">
  33. <img src=".github/assets/soundboard-light.webp" alt="The Soundboard example app rendered by the Native SDK engine: a music library with album cover art, search, and a playback bar" width="100%">
  34. </picture>
  35. The Soundboard example rendered by the Native SDK engine. More apps are in [examples/](./examples):
  36. - [Chatbot](./examples/chatbot): streaming responses, text editing, and TypeScript effects.
  37. - [Soundboard](./examples/soundboard): audio playback, search, assets, and context menus.
  38. - [System monitor](./examples/system-monitor): subprocess effects, tables, charts, and timers.
  39. - [Calculator](./examples/calculator): markup, keyboard input, and theming.
  40. See the [example catalog](./examples/README.md) for additional apps and their authoring languages.
  41. ## Documentation
  42. - [Quick Start](https://native-sdk.dev/docs/quick-start): installation and your first app.
  43. - [Native UI](https://native-sdk.dev/docs/native-ui): markup, layout, and bindings.
  44. - [Components](https://native-sdk.dev/docs/components): the built-in component catalog.
  45. - [TypeScript Services](https://native-sdk.dev/docs/typescript/services): external work outside the core.
  46. - [Testing](https://native-sdk.dev/docs/testing): headless app tests and runtime integration.
  47. - [Automation](https://native-sdk.dev/docs/automation): inspect and drive a running app.
  48. - [Packaging](https://native-sdk.dev/docs/packaging): create distributable packages.
  49. ## Contributing
  50. See [CONTRIBUTING.md](./CONTRIBUTING.md) for repository setup and local checks. For larger changes, open an issue to discuss the design first.
  51. ## License
  52. [Apache-2.0](./LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.