https://github.com/raphgl/termcl
Terminal Control Library for Odin
https://github.com/raphgl/termcl
ansi-escape-codes ansi-escape-sequences cli ncurses terminal tui
Last synced: 3 months ago
JSON representation
Terminal Control Library for Odin
- Host: GitHub
- URL: https://github.com/raphgl/termcl
- Owner: RaphGL
- License: bsd-3-clause
- Created: 2025-03-03T18:54:59.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-23T18:22:19.000Z (3 months ago)
- Last Synced: 2025-06-23T19:31:57.179Z (3 months ago)
- Topics: ansi-escape-codes, ansi-escape-sequences, cli, ncurses, terminal, tui
- Language: Odin
- Homepage:
- Size: 422 KB
- Stars: 37
- Watchers: 2
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TermCL
Terminal control and ANSI escape code library for Odin
·
Report Bug
·
Request Feature
Table of Contents
TermCL is an Odin library for writing TUIs and CLIs with.
The library is compatible with any ANSI escape code compatible terminal, which is to say, almost every single modern terminal worth using :)
The library should also work on windows and any posix compatible operating system.
## How it works
The library uses a Screen struct to represent the terminal. To start a CLI/TUI you need to call `init_screen`,
this function calls the operating system to get information on the terminal state.
> [!NOTE]
> you should call destroy_screen before you exit to restore the terminal state otherwise you might end up with a weird behaving terminal
After that you should just set the terminal to whatever mode you want with the `set_term_mode` function, there are 3 modes you can use:
- Raw mode (`.Raw`) - prevents the terminal from processing the user input so that you can handle them yourself
- Cooked mode (`.Cbreak`) - prevents user input but unlike raw, it still processed for signals like Ctrl + C and others
- Restored mode (`.Restored`) - restores the terminal to the state it was in before the program started messing with it, this is also called when the screen is destroyed
After doing this, you should be good to go to do whatever you want.
Here's a few minor things to take into consideration:
- To handle input you can use the `read` function or the `read_blocking` function, as the default read is nonblocking.
- There's convenience functions that allow you to more easily process input, they're called `parse_keyboard_input` and `parse_mouse_input`
- Whatever you do won't show up on screen until you `blit`, since everything is cached first, windows also have their own cached escapes, so make sure you blit them as well
## Usage
```odin
package main
import "termcl"
main :: proc() {
scr := termcl.init_screen()
defer termcl.destroy_screen(&scr)
termcl.set_text_style(&scr, {.Bold, .Italic})
termcl.write(&scr, "Hello ")
termcl.reset_styles(&scr)
termcl.set_text_style(&scr, {.Dim})
termcl.set_color_style_8(&scr, .Green, nil)
termcl.write(&scr, "from ANSI escapes")
termcl.reset_styles(&scr)
termcl.move_cursor(&scr, 10, 10)
termcl.write(&scr, "Alles Ordnung")
termcl.blit(&scr)
}
```
Check the `examples` directory to see more on how to use it.