Getting Started

Updated Nov 24, 2025
  1. Step 01

    Installation

    Netsuke is typically built from source using Cargo:

    cargo build --release
    # The executable will be in target/release/netsuke
    

    Refer to the project's README.md or release pages for pre-compiled binaries if available. Ensure the ninja executable is also installed and available in your system's PATH.

  2. Step 02

    Basic Usage

    The primary way to use Netsuke is through its command-line interface (CLI). The default command is build.

    1. Create a Netsukefile: Define your build rules and targets in a YAML file named Netsukefile in your project root.

    2. Run Netsuke: Execute the netsuke command.

    netsuke # Builds default targets defined in Netsukefile
    netsuke build target_name another_target # Builds specific targets
    

    If no Netsukefile is found, Netsuke will provide a helpful error message guiding you.