cli

cli - command-line applications from typed declarations.

const cli = @import("cli");

const ServeFlags = struct {
    port: u16 = 8080,
    verbose: u8 = 0,
};

// What the fields mean (shared with `cfg`), then how they are spelled here.
const Specs = field.Set(.{field.Spec(ServeFlags){ .fields = .{
    .port = .{ .help = "Port to listen on", .checks = &.{.min(1)} },
} }});
const serve_flags = cli.flags(ServeFlags, Specs, .{ .fields = .{
    .port = .{ .short = 'p', .env = "PORT" },
    .verbose = .{ .short = 'v', .count = true },
} });

fn serve(ctx: *cli.Context, flags: ServeFlags) !void {
    try ctx.out.print("listening on {d}\n", .{flags.port});
}

const root = cli.command(.{
    .name = "app",
    .summary = "An example",
    .subcommands = .{
        cli.command(.{ .name = "serve", .flags = serve_flags, .run = serve }),
    },
});

pub fn main(init: std.process.Init) u8 {
    const app: cli.App = .{ .root = &root, .version = "0.1.0" };
    return app.run(init);
}

The module imports std, term (for display widths, color detection, and the styles of Theme), and field (specs, shared with cfg). Flag types may follow the parse convention shared with cfg (pub fn parse(text: []const u8) !T), and Context.changedFlags returns records that cfg.Config.bindFlags accepts.

Declarations

The full API reference