# @opentui/solid

> SolidJS renderer for OpenTUI

Latest version **0.6.6** (published 2026-10-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @opentui/solid
pnpm add @opentui/solid
yarn add @opentui/solid
bun add @opentui/solid
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; popular repo.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.6.6 |
| Published | 2026-10-14 |
| First published | 2025-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 331.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 13394 |
| Maintainers | kommander, fanjie, thdxr |

## Links

- npm: https://www.npmjs.com/package/@opentui/solid
- Repository: https://github.com/anomalyco/opentui
- Homepage: https://github.com/anomalyco/opentui#readme
- Issues: https://github.com/anomalyco/opentui/issues
- npm.io page: https://npm.io/package/@opentui/solid

## Dependencies (7)

- [s-js](https://npm.io/package/s-js.md) ^0.4.9
- [entities](https://npm.io/package/entities.md) 7.0.1
- [@babel/core](https://npm.io/package/@babel/core.md) 7.29.7
- [@opentui/core](https://npm.io/package/@opentui/core.md) 0.6.6
- [babel-preset-solid](https://npm.io/package/babel-preset-solid.md) 1.9.12
- [@babel/preset-typescript](https://npm.io/package/@babel/preset-typescript.md) 7.27.1
- [babel-plugin-module-resolver](https://npm.io/package/babel-plugin-module-resolver.md) 5.0.2

## Recent versions

- 0.6.6 (latest) — 2026-10-14
- 0.0.0-20261004-7dad729e (snapshot) — 2026-10-04
- 0.6.5 — 2026-10-14
- 0.6.4 — 2026-10-13
- 0.6.3 — 2026-10-13
- 0.6.2 — 2026-10-12
- 0.6.1 — 2026-10-11
- 0.6.0 — 2026-10-10
- 0.5.17 — 2026-10-08
- 0.5.16 — 2026-10-07
- 0.5.15 — 2026-10-07
- 0.0.0-20261002-f9ace790 — 2026-10-02
- 0.0.0-20261001-d06d3aba — 2026-10-01
- 0.5.14 — 2026-09-30
- 0.5.13 — 2026-09-30
- … 325 more at https://npm.io/package/@opentui/solid/versions

## README

<p align="center">
  <a href="https://opentui.com">
    <img alt="OpenTUI logo" src="https://opentui.com/opentui-logo-auto.svg" width="270" />
  </a>
</p>

<div align="center">
    <a href="https://www.npmjs.com/package/@opentui/core"><img alt="npm version" src="https://img.shields.io/npm/v/@opentui/core?style=flat-square" /></a>
    <a href="https://github.com/anomalyco/opentui/actions/workflows/build-core.yml"><img alt="Core build status" src="https://img.shields.io/github/actions/workflow/status/anomalyco/opentui/build-core.yml?style=flat-square&branch=main" /></a>
</div>

OpenTUI is a library to build terminal user interfaces.

- It is written in Zig.
- You write TypeScript directly or through React and Solid.
- You arrange boxes and text with flexbox.
- You add selects, inputs, and scroll boxes with keyboard and mouse controls.
- You can play sounds, show images, and render 3D graphics.

OpenCode uses OpenTUI in production for millions of users.

[Website](https://opentui.com) | [Documentation](https://opentui.com/docs) | [Packages](https://opentui.com/packages)

## Packages

- [`@opentui/core`](packages/core) - Native terminal UI library with TypeScript bindings.
- [`@opentui/react`](packages/react) - React renderer for building terminal user interfaces with OpenTUI Core.
- [`@opentui/solid`](packages/solid) - Solid renderer for building terminal user interfaces with OpenTUI Core.
- [`@opentui/keymap`](packages/keymap) - Key binding and command routing library for terminal and browser applications.
- [`@opentui/qrcode`](packages/qrcode) - QR code encoder and renderable with React and Solid surfaces.
- [`@opentui/three`](packages/three) - Three.js WebGPU renderer for OpenTUI.
- [`@opentui/ssh`](packages/ssh) - SSH server integration for OpenTUI applications.

**Private packages**

- [`@opentui/native`](packages/native) - Private workspace with the Zig implementation, native tests, and benchmarks.
- [`@opentui/examples`](packages/examples) - Private workspace with example applications and a standalone examples executable.
- [`@opentui/web`](packages/web) - Private workspace with the documentation website and the AI agent skill.

## AI agent skill

Install the OpenTUI documentation as a skill for your AI coding assistant with [`npx skills`](https://skills.sh):

```bash
npx skills add https://opentui.com --skill opentui
```

Add `-g` to install the skill globally. The skill matches the latest release, and `npx skills update` moves it to each
new release. Install from `https://opentui.com/docs/next` to follow the main branch. A skill installed with
`npx skills add anomalyco/opentui` follows the main branch; run the command above to switch it to releases.

## Development

Development requires Bun 1.4.1 or later and Zig 0.16.0.

See [AGENTS.md](AGENTS.md) for engineering, tooling, and verification conventions.

```bash
bun install
```

Run package scripts from their package directory. Run `bun run build` from the repository root after you change
native code or cross-package build outputs. Ordinary TypeScript changes do not require a root build.

Run repository tests and static checks from the repository root:

```bash
bun run test
bun run fmt:check
bun run lint
```

To link the source packages into a Bun-managed project, install that project's dependencies, then run
`./scripts/link-opentui-dev.sh /path/to/project` from the repository root. Add `--react` or `--solid` when needed.

## Contributing

OpenTUI is open for contributions.

## License

OpenTUI is licensed under the [MIT License](LICENSE).

---
_Source: https://npm.io/package/@opentui/solid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
