cirious_codex_term 0.1.0

Next-generation native ANSI terminal control and formatting.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

<div align="center">

# 🖥️ Cirious Codex Term

**Native ANSI Terminal Control & Formatting**

[![CI](https://github.com/cirious-studio/cirious_codex_term/actions/workflows/ci.yml/badge.svg)](https://github.com/cirious-studio/cirious_codex_term/actions/workflows/ci.yml) [![Crates.io](https://img.shields.io/crates/v/cirious_codex_term.svg)](https://crates.io/crates/cirious_codex_term) [![Docs.rs](https://docs.rs/cirious_codex_term/badge.svg)](https://docs.rs/cirious_codex_term) [![Language](https://img.shields.io/badge/Language-Rust-orange?logo=rust)](https://www.rust-lang.org/) [![License](https://img.shields.io/badge/License-MIT%2FApache-blue.svg)](#-license)

</div>

---

## 📖 Overview

**Cirious Codex Term** is a highly optimized, dependency-free foundational library for terminal manipulation. It provides native ANSI escape sequence generation for colors, text styling, and full cursor control. 

Designed to be the ultimate bedrock for CLI tools within the Cirious ecosystem, prioritizing zero-cost abstractions and flawless terminal integration.

## ✨ Features

- Core color manipulation (16 colors, 256 colors, TrueColor RGB).
- Text formatting traits (Bold, Italic, Blink, Dim, etc.).
- Absolute and relative cursor positioning.
- Screen manipulation and clearing.

---

## 🚀 Quick Start
 
Add the following to your `Cargo.toml`:

```toml
[dependencies]
cirious_codex_term = "0.1"
```

And then in your code:

```rust
use cirious_codex_term::{Color, Cursor, Screen, Style, StyleExt};
 
fn main() {
  // Clear the screen
  Screen::clear();
   
  // Move cursor and print styled text
  Cursor::set_position(5, 5);
  print!(
    "{} {}Hello, Codex Term!{}",
    Style::Bold.to_str(),
    Color::Cyan.to_fg_str(),
    Style::Reset.to_str()
  );
   
  // Use extension traits for fluent styling
  println!("{}", "This text is red and underlined".red().underline());
   
  // Hide cursor
  Cursor::hide();
   
  // Move cursor and print again
  Cursor::set_position(10, 10);
  println!("{}", "Cursor is hidden!".green());
   
  // Show cursor
  Cursor::show();
}
```
---

## 🚧 Current Status & Roadmap

The architecture is currently being mapped out for the upcoming `v0.2` release:

- [ ] **Windows ANSI:** Auto-enable native ANSI support on Windows.
- [ ] **Terminal Dimensions:** Methods to query terminal width and height dynamically.
- [ ] **Raw Mode Toggle:** Ability to switch the terminal to raw mode for unbuffered, character-by-character input reading.
- [ ] **NO_COLOR Standard:** Automatic respect for the `NO_COLOR` environment variable to disable styling dynamically.
- [ ] **Async Key Events:** Foundational support for reading non-blocking keyboard and mouse events.


---

## 📜 License

Licensed under either of the following, at your option:

* **[MIT License](LICENSE-MIT)**
* **[Apache License 2.0](LICENSE-APACHE)**

---

<div align="center">
  <i>Minimalist by design. Consistent in execution.</i><br>
  <sub>Engineered by Cirious Studio</sub>
</div>