Installation

args.zig is designed to be easily integrated into your Zig projects using the Zig package manager.

Prerequisites

• Zig 0.15.0 or later.

Adding to your Project

Release Installation (Recommended)

To install the latest stable release (v0.0.2), verify the hash and add it to your build.zig.zon by running:

zig fetch --save https://github.com/muhammad-fiaz/args.zig/archive/refs/tags/0.0.3.tar.gz

This command will automatically download the package and update your build.zig.zon with the correct url and hash.

Nightly Installation

If you want to use the latest features from the main branch:

zig fetch --save git+https://github.com/muhammad-fiaz/args.zig

Configuring build.zig

Once added to build.zig.zon, you need to expose the module to your executable in build.zig.

Add the following lines to your build.zig file:

pub fn build(b: *std.Build) void {
    // ... setup target and optimize ...

    const args_dep = b.dependency("args", .{
        .target = target,
        .optimize = optimize,
    });

    const exe = b.addExecutable(.{
        // ... executable config ...
    });

    // Add the args module import
    exe.root_module.addImport("args", args_dep.module("args"));

    // ... install artifact ...
}

Verifying Installation

Create a simple main.zig to verify the installation:

const std = @import("std");
const args = @import("args");

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();
    const allocator = gpa.allocator();

    var parser = try args.ArgumentParser.init(allocator, .{
        .name = "hello",
    });
    defer parser.deinit();

    try parser.addFlag("verbose", .{
        .short = 'v',
        .help = "Enable verbose output"
    });

    var result = try parser.parseProcess();
    defer result.deinit();

    if (result.getBool("verbose") orelse false) {
        std.debug.print("Hello from args.zig!\n", .{});
    }
}

Run it with:

zig build run -- --verbose