Getting Started

Welcome to RetUI!

This guide will help you install RetUI and create your first terminal application in just a few minutes.

Prerequisites

Before you begin, make sure you have:

• Go 1.24 or later
• A terminal that supports ANSI escape sequences
• Basic knowledge of Go

Install RetUI

Create a new Go project if you don't already have one.

mkdir myapp
cd myapp
go mod init myapp

Install RetUI.

go get github.com/subhasundardass/retui

Your First Application

Create a file named main.go.

package main

import (
    "github.com/subhasundardass/retui"
)

func App() retui.Element {
    return retui.Text("Hello, RetUI!")
}

func main() {
    retui.Run(App)
}

Run the application.

go run .

You should see your first RetUI application running in the terminal.

Project Structure

A simple RetUI project might look like this:

myapp/
├── go.mod
├── go.sum
├── main.go
├── components/
├── screens/
└── styles/

As your application grows, you can organize components, screens, and other code into separate packages.

What's Next?

Now that you have your first application running, continue with these guides:

• Core Concepts
• Layout System
• Components
• Hooks
• Styling

These topics will introduce the ideas that make RetUI easy to build and maintain.