Skip to main content

init

This document provides an overview of the commands and options available under buck2 init.

buck2 init

Initialize a buck2 project

Usage: buck2 init [OPTIONS] [PATH]

Arguments:

  • <PATH> The path to initialize the project in. The folder does not need to exist

    • Default value: .

Options:

  • --no-prelude Don't include the standard prelude or generate toolchain definitions

  • --allow-dirty Initialize the project even if the git repo at [PATH] has uncommitted changes

  • --git Also initialize a git repository at the given path, and set up an appropriate .gitignore file

  • --console <super|simple|...> Which console to use for this command

    • Default value: auto
    • Possible values:
      • auto
      • none
      • simple
      • simplenotty
      • simpletty
      • super
  • --ui <UI> Configure additional superconsole ui components.

    Accepts a comma-separated list of superconsole components to add. Possible values are:

    dice - shows information about evaluated dice nodes debugevents - shows information about the flow of events from buckd

    These components can be turned on/off interactively. Press 'h' for help when superconsole is active.

    • Possible values:
      • dice
      • debugevents
      • io: I/O panel
      • re: RE panel
  • --no-interactive-console Disable console interactions