Documentation

Documentation Hub

Welcome to the Netsuke documentation. Start with the YAML manifest, learn how Jinja expands it, then follow the path through validation and Ninja execution.

Start Here

Getting Started

Install Netsuke, create a small Netsukefile, and build the default targets.

Start tutorial

How it Works

Understand the six-stage pipeline: YAML first, template expansion second, Ninja last.

Learn the basics

Browse by Topic

Manifests

Rules & Targets

CLI Reference

Self-documenting builds

Netsuke configurations are designed to be read by humans. The syntax is minimal, removing the boilerplate found in other build tools.

View full examples

examples/basic/Netsukefile RO

# Compile a simple C program
netsuke_version: "1.0.0"

rules:
  - name: "compile"
    command: "gcc -c {{ ins }} -o {{ outs }}"

targets:
  - name: "hello_world"
    command: "gcc {{ ins }} -o {{ outs }}"
    sources: ["main.o", "print.o"]

Popular Guides

View all guides

Building a Basic C Application

Learn how to compile and link a small C program with explicit object-file dependencies.

Create Your First Project

Follow the first-project walkthrough and see how Netsuke turns a manifest into a build plan.

Defining Rules

Understand how reusable rules describe command templates, inputs, and outputs.

Still have questions?

Can't find what you're looking for in the docs? Open an issue on GitHub.

GitHub Issues