nsh README

README проекта с github.com/longbridge/nsh. Одним файлом markdown: README.md.

Native Shell (NSH)

Build once, native everywhere. Native Shell is a native UI framework for iOS, Android, macOS, Windows, Linux and the web, built in Rust. It unifies components, state, logic and API, with app-owned visual design and platform rendering: native views on iOS, Android, macOS, Windows and Linux, HTML on the web, GPUI in GPUI apps, character Cells in a terminal, with the platform's own text, input and interaction (a menu is a popup on the desktop and a sheet on a phone). Write the whole app in Rust, its screens in TSX, or combine both with shared Rust components.

image

Package it as a standalone app on every platform, or embed it in an existing one. On the same engine, apps load TSX modules at run time — plugins, features, UI generated by AI — delivered as signed packages and run in a sandbox the host configures.

Documentation, guides and live demos: nsh.dev.

Goals

Native views and interaction, with an app-owned design: NSH shares components, state and APIs across platforms, while the app controls colors, typography, spacing, shapes and motion. nsh/base provides the behavior and accessible structure of common controls such as Button, Checkbox and Switch; apps and community libraries give them a look. Platform modules expose capabilities specific to their platforms, such as the mobile system tab bar.

Read Goals and design principles for the component boundaries and how these goals guide Rust apps, TSX modules and AI-generated UI.

Features

Platforms

Platform Drawn with Embed with Requires
iOS UIKit, CoreText NshAppView (Swift, NativeShell.xcframework) iOS 15+
Android Android views, StaticLayout NshView (Java / Kotlin, nsh.aar) Android 8 (API 26)+
macOS AppKit, Core Animation, CoreText AppView (Rust, nsh-platform-macos) macOS 14+
Windows Win32, Direct2D, DirectWrite AppView (Rust, nsh-platform-windows) Windows 10 1809+
Linux GTK 4, Pango AppView (Rust, nsh-platform-linux) GTK 4.14+
GPUI (macOS, Windows, Linux) GPUI (GPUI Fast) AppView (Rust, a GPUI view, nsh-platform-gpui) macOS, Windows; Linux with Vulkan
Terminal ratatui, the terminal's Cell grid AppView (Rust, an area of a ratatui frame, nsh-platform-tui) Terminals on macOS, Windows, Linux
Web HTML, CSS createPlayer (JavaScript) or an iframe Modern browsers

Each desktop runs and packages apps with its own backend (AppKit, Win32, GTK 4). The GPUI backend draws with GPUI on all three desktops and embeds NSH in GPUI and GPUI Kit apps; nsh run --target gpui shows an app as they do. The web platform (nsh run --target web, nsh package --target web) publishes apps as static sites and runs the website's live demos. The terminal backend (nsh run --target tui) draws apps on a terminal's character grid in its own colors, with the keyboard and the mouse.

Quick start

Install the nsh command (other ways):

macOS / Linux
curl -fsSL https://nsh.dev/install.sh | sh

The nightly build of the latest main, rebuilt every night that it changes:

curl -fsSL https://nsh.dev/install.sh | sh -s -- --nightly
Homebrew
brew install longbridge/tap/nsh
Windows (PowerShell)
irm https://nsh.dev/install.ps1 | iex
From source (macOS / Linux)

Build and install the latest main from source (Git, Rust and the platform build dependencies required):

curl -fsSL https://nsh.dev/install.sh | sh -s -- --source

Re-run to update. The checkout stays in ~/.nsh/source for runtime builds.

Choose how to write your app:

Rust TSX
Create nsh init my-app --template rust nsh init my-app --template ts
Write Rust components, typed styles and signals TSX components, Tailwind classes and signals
Iterate Rebuild and restart on Rust changes Hot updates that preserve state
Toolchain nsh and Rust, built with huacnlee/cargo nsh

You can also combine them (nsh init my-app --template mixed): TSX screens import your Rust components and modules. See Building with Rust for Rust apps and mixed projects.

Run either app on your chosen platform:

iOS
nsh run my-app --target ios        # iOS simulator; requires Xcode
nsh run my-app --target catalyst   # Mac Catalyst window on macOS
Android
nsh run my-app --target android    # emulator or device; requires the Android SDK
macOS
nsh run my-app --target macos      # AppKit window
Windows
nsh run my-app --target windows    # Win32 window
Linux
nsh run my-app --target linux      # GTK 4 window
GPUI (macOS, Windows, Linux)
nsh run my-app --target gpui       # as GPUI apps that embed it show it
Terminal
nsh run my-app --target tui        # in the current terminal
Web
nsh run my-app --target web        # open in the browser

The Rust template includes a Cargo project with its root component in src/lib.rs. The TSX template includes App.tsx, nsh.json and tsconfig.json, with generated TypeScript declarations in .nsh/types for your editor. Logs and errors show in the terminal. What each platform needs: Installation.

Examples

Example What it shows
examples/gallery-rs The gallery written in Rust: an app with no TSX and no QuickJS
examples/rust-exports A TSX app using a component, a module and a class of its own Rust crate
examples/gallery A tour of what NSH supports: lists, navigation, forms, controls, gestures, animation, images, styles, text, web view and video, fetch
examples/counter The smallest app
examples/tasks-rs A small Rust app with a store, pages, a list, a system alert and tests, laid out as the Coding Guides say
examples/tasks The same app in TSX
examples/hopper A dark, tabbed dashboard built only from primitives: interactive canvas charts, sliders, menus, animation
examples/desktop A desktop app with a title bar and menus of its own (nsh/desktop)
examples/embed-ios, examples/embed-android NSH inside existing native apps, with a native component the app registers
examples/bench Rust components against the same components in TSX
cargo run

Skills for AI coding agents

Install the NSH skills for your coding agent (Claude Code, Codex, Cursor, Gemini CLI and others), so it follows NSH's model in Rust, Rust with TSX, or TSX:

npx skills add longbridge/nsh
Skill What it gives the agent
nsh Building apps in Rust (preferred), Rust with TSX, or TSX: the Coding Guides, a page per mode, tooling, and a tested app in Rust and in TSX
nsh-design-guides The Design Guides, for any screen, interaction or interface copy

Acknowledgements

NSH builds on the ideas of these projects:

License

Licensed under the Apache License, Version 2.0.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be licensed under Apache-2.0, without any additional terms or conditions.

nsh (longbridge/nsh)

Ищем в базе…

3K ·GitHub
Что это такое?NSH — это движок на Rust для создания кроссплатформенных приложений, где экраны пишутся на TSX (или на Rust), а каждая платформа отрисовывает их собственным нативным интерфейсом: UIKit на iOS, Android Views на Android, AppKit на macOS, Win32/Direct2D на Windows, GTK 4 на Linux, GPUI на десктопах или HTML в вебе.
Это фреймворк, на котором я строю всё приложение, или то, что я просто встраиваю?Работает в обоих вариантах: можно собрать самостоятельное приложение полностью на NSH или встроить NSH в уже существующее нативное приложение вместе с такими компонентами, как карты и веб-вью.
Как начать работу?Установите CLI 'nsh' через Homebrew на macOS/Linux или установщик PowerShell на Windows, затем выполните 'nsh init my-app --template ts' (или '--template rust' / '--template mixed'), а 'nsh run --target ' — для запуска.
Какие версии ОС нужны для каждой платформы?iOS 15+, Android 9 (API 28)+, macOS 14+, Windows 10 1809+ и GTK 4.14+ в Linux; бэкенду GPUI дополнительно нужен Vulkan в Linux.
Если экраны TSX можно доставлять во время выполнения, это угроза безопасности?Динамически доставляемые модули TSX должны быть подписанными пакетами и работают внутри песочницы, возможности которой настраивает хост-приложение, так что хост сам контролирует, что могут делать загруженные экраны.
Писать приложение на Rust или на TSX?Можно либо то, либо другое, либо оба сразу: Rust даёт типизированные компоненты и сигналы с пересборкой при изменениях, TSX — компоненты, стилизованные через Tailwind, с горячими обновлениями, которые сохраняют состояние, а шаблон 'mixed' позволяет экранам TSX импортировать ваши компоненты на Rust.
Что даёт бэкенд GPUI по сравнению с обычными нативными представлениями?Бэкенд GPUI отрисовывает одно и то же приложение с помощью GPUI во всех трёх десктопных ОС вместо нативного инструментария каждой системы, а также может встраиваться напрямую в другие приложения на GPUI или GPUI Kit.
Могут ли ИИ-инструменты генерировать экраны NSH?Да — NSH создаёт объявления TypeScript и документацию, понятную моделям, специально для того, чтобы экраны TSX и Tailwind, сгенерированные ИИ, можно было создавать и запускать нативно на каждой платформе.
Что охватывают примеры приложений?Они варьируются от минимального приложения 'counter' до полной галереи виджетов 'gallery', её версии только на Rust без TSX/QuickJS, демо встраивания в нативные приложения для iOS и Android и бенчмарка, который сравнивает компоненты на Rust с теми же компонентами на TSX.
Какие есть похожие проекты?react-native, ng-native, perry, expo, lynx, weex, PakePlus, native
В каких он темах?generative-ui, jsx, native, mobile-app, ui, sdk, mobile, ios, framework, android, rust, gui
Автор
longbridge
Размер
82.1 MB
Звёзды
3K
Возраст
1 мес
Коммиты · 90 дней