KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

tuile

★ 218 Open GitHub ↗

A cross-platform Text UI (TUI) library in Zig

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

<h3 align="center">Tuile</h3>

A Text User Interface library for Zig.
 
 Breaking changes are possible.
 
 <a href="https://github.com/akarpovskii/tuile">Explore the docs »</a>
 
 
 <a href="https://github.com/akarpovskii/tuile/tree/main/examples">View Examples</a>
 ·
 <a href="https://github.com/akarpovskii/tuile/issues/new?labels=bug&template=bug-report.md">Report Bug</a>
 ·
 <a href="https://github.com/akarpovskii/tuile/issues/new?labels=enhancement&template=feature-request.md">Request Feature</a>
 
</div>

<details>
 <summary>Table of Contents</summary>
 <ol>
 <li>
 <a href="#about-the-project">About The Project</a>
 </li>
 <li>
 <a href="#getting-started">Getting Started</a>
 <ul>
 <li><a href="#prerequisites">Prerequisites</a></li>
 <li><a href="#installation">Installation</a></li>
 </ul>
 </li>
 <li><a href="#usage">Usage</a></li>
 <li><a href="#cross-compilation">Cross-compilation</a></li>
 <li><a href="#roadmap">Roadmap</a></li>
 <li><a href="#contributing">Contributing</a></li>
 <li><a href="#license">License</a></li>
 <li><a href="#contact">Contact</a></li>
 <li><a href="#acknowledgments">Acknowledgments</a></li>
 </ol>
</details>

## About The Project

Tuile is a Text User Interface library written in Zig.

Tuile uses [`crossterm`](docs/Backends.md#crossterm) backend by default which works on all UNIX and Windows terminals and supports cross-compilation (powered by [`build.crab`](https://github.com/akarpovskii/build.crab)).

See [`Backends`](docs/Backends.md) for the list of supported backends, or file a [feature request](https://github.com/akarpovskii/tuile/issues/new?labels=enhancement&template=feature-request.md) if you want to have another one added.

![Demo VHS recording](https://raw.githubusercontent.com/akarpovskii/tuile/main/examples/images/demo.png)

Checkout the other examples [here](./examples/).

(<a href="#readme-top">back to top</a>)

## Getting Started

### Prerequisites

* Zig 0.12.0+

* Non-default [`backends`](docs/Backends.md) may have additional requirements.

### Installation

1. Add dependency to your `build.zig.zon`

```sh
zig fetch --save https://github.com/akarpovskii/tuile/archive/refs/tags/v0.1.3.tar.gz
```

2. Import Tuile in `build.zig`:

```zig
const tuile = b.dependency("tuile", .{});
exe.root_module.addImport("tuile", tuile.module("tuile"));
```

(<a href="#readme-top">back to top</a>)

## Usage

```zig
const tuile = @import("tuile");

pub fn main() !void {
    var tui = try tuile.Tuile.init(.{});
    defer tui.deinit();

try tui.add(
        tuile.block(
            .{
                .border = tuile.Border.all(),
                .border_type = .rounded,
                .layout = .{ .flex = 1 },
            },
            tuile.label(.{ .text = "Hello World!" }),
        ),
    );

try tui.run();
}
```

You can find more examples in the [examples folder](./examples/)

(<a href="#readme-top">back to top</a>)

## Cross-compilation

To compile an application that uses Tuile for another target, just add `-Dtarget=<desired target>` when building your app and make sure to forward it to Tuile:

#### **`build.zig`**
```zig
const target = b.standardTargetOptions(.{});
const tuile = b.dependency("tuile", .{
  .target = target
});
```

(<a href="#readme-top">back to top</a>)

## Roadmap

In no particular order:

- [ ] Documentation
- [ ] Grid layout
- [ ] Windows and dialogs
- [ ] Menu bar
- [ ] More widgets

See the [open issues][issues-url] for a full list of proposed features (and known issues).

(<a href="#readme-top">back to top</a>)

## Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
3. Commit your Changes (`git commit -m 'Add some Amazing Feature'`)
4. Push to the Branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

(<a href="#readme-top">back to top</a>)

## License

Distributed under the MIT License. See [`LICENSE`][license-url] for more information.

(<a href="#readme-top">back to top</a>)

## Acknowledgments

* [Best-README-Template](https://github.com/othneildrew/Best-README-Template)

(<a href="#readme-top">back to top</a>)

[contributors-shield]: https://img.shields.io/github/contributors/akarpovskii/tuile.svg?style=for-the-badge
[contributors-url]: https://github.com/akarpovskii/tuile/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/akarpovskii/tuile.svg?style=for-the-badge
[forks-url]: https://github.com/akarpovskii/tuile/network/members
[stars-shield]: https://img.shields.io/github/stars/akarpovskii/tuile.svg?style=for-the-badge
[stars-url]: https://github.com/akarpovskii/tuile/stargazers
[issues-shield]: https://img.shields.io/github/issues/akarpovskii/tuile.svg?style=for-the-badge
[issues-url]: https://github.com/akarpovskii/tuile/issues
[license-shield]: https://img.shields.io/github/license/akarpovskii/tuile.svg?style=for-the-badge
[license-url]: https://github.com/akarpovskii/tuile/blob/master/LICENSE.txt
[examples-url]: https://github.com/akarpovskii/tuile/tree/main/examples
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/akarpovskii
[product-screenshot]: images/screenshot.png

tuile

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README