Skip to main content

init

These are the flags/commands under buck2 init and their --help output:

buck init

Buck2 Init

This command is intended to be part-tutorial part-convenience for generating buck2 projects. Given a
path and optional name (in the case that the folder name is not desirable).

Usage: buck2-release init [OPTIONS] [PATH]

Arguments:
[PATH]
The path to initialize the project in. The folder does not need to exist

[default: .]

Options:
-n, --name <NAME>
The name for the project. If not provided will default to the last segment of the path

--no-prelude
Don't generate a prelude or a toolchain

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

--git


-h, --help
Print help (see a summary with '-h')

Console Options:
--console <super|simple|...>
Which console to use for this command

[env: BUCK_CONSOLE=]
[default: auto]
[possible values: simple, simplenotty, simpletty, super, auto, none]

--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

[env: BUCK_NO_INTERACTIVE_CONSOLE=]

Universal Options:
-v, --verbose <VERBOSITY>
How verbose buck should be while logging.

Values: 0 = Quiet, errors only; 1 = Show status. Default; 2 = more info about errors; 3 =
more info about everything; 4 = more info about everything + stderr;

It can be combined with specific log items (stderr, full_failed_command, commands,
actions, status, stats, success) to fine-tune the verbosity of the log. Example usage
"-v=1,stderr"

[default: 1]

--oncall <ONCALL>
The oncall executing this command

--client-metadata <CLIENT_METADATA>
Metadata key-value pairs to inject into Buck2's logging. Client metadata must be of the
form `key=value`, where `key` is a snake_case identifier, and will be sent to backend
datasets