zterm

A Zig implementation of console_codes (4).

Features

• No memory allocator needed
• Generate attributes containing multiple styles (e.g. bold, italic) and colors (including foreground/background)
  • Fully generatable at compile time
  • Can be wrapped around any value needing formatting
  • Wrappable to standard output to apply attributes to every print call
• Cursor position control (absolute & relative)

Plans

NO_COLOR support
Accept intput
Get display size, get mouse position

Installation

fetch

Get the latest version:

zig fetch --save git+https://github.com/kioz-wang/zterm

To fetch a specific version (e.g., v0.14.1):

zig fetch --save https://github.com/kioz-wang/zterm/archive/refs/tags/v0.14.1.tar.gz

Version Notes

See https://github.com/kioz-wang/zterm/releases

The version number follows the format vx.y.z:

• x: Currently fixed at 0. It will increment to 1 when the project stabilizes. Afterward, it will increment by 1 for any breaking changes.
• y: Represents the supported Zig version. For example, vx.14.z supports Zig 0.14.0.
• z: Iteration version, where even numbers indicate releases with new features or significant changes (see milestones), and odd numbers indicate releases with fixes or minor changes.

import

Use addImport in your build.zig (e.g.):

const exe_mod = b.createModule(.{
    .root_source_file = b.path("src/main.zig"),
    .target = target,
    .optimize = optimize,
});
exe_mod.addImport("zterm", b.dependency("zterm", .{}).module("zterm"));
const exe = b.addExecutable(.{
    .name = "your_app_name",
    .root_module = exe_mod,
});
b.installArtifact(exe);

const run_cmd = b.addRunArtifact(exe);
run_cmd.step.dependOn(b.getInstallStep());
if (b.args) |args| {
    run_cmd.addArgs(args);
}

const run_step = b.step("run", "Run the app");
run_step.dependOn(&run_cmd.step);

After importing the zterm, you could get a terminal applied stdout by:

const zterm = @import("zterm").stdout();

APIs

See https://kioz-wang.github.io/zterm/#doc

Examples

Welcome to submit PRs to link your project that use zterm!

More real-world examples are coming!

• zterm_cli

License

MIT © Kioz Wang