// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

[[build_init_plugin]]
= Build Init Plugin


The Build Init plugin can be used to create a new Gradle build. It supports creating brand new Gradle builds of various types as well as converting existing Apache Maven builds to Gradle.

import org.gradle.buildinit.tasks.InitBuild;

/**
 * The build init plugin.
 *
 * @see <a href="https://docs.gradle.org/current/userguide/build_init_plugin.html">Build Init plugin reference</a>
 */
public abstract class BuildInitPlugin implements Plugin<Project> {

    private static final String COMMENTS_PROPERTY = "org.gradle.buildinit.comments";

    @Override
    public void apply(Project project) {

1 actionable task: 1 executed
----
=====
====

For more information, see link:{userManualPath}/custom_plugins.html[Gradle Plugins reference chapter].

====

For a more guided tour with plugin development, see link:https://gradle.org/guides/?q=Plugin%20Development[the guides for plugin development].

== Utility

<<base_plugin.adoc#base_plugin,Base>>::
Provides common lifecycle tasks, such as `clean`, and other features common to most builds.

<<build_init_plugin.adoc#build_init_plugin,Build Init>>::

        clientMetaData.describeCommand(message, "init");
        message.append("'\n\n")
            .append(documentationRegistry.getDocumentationRecommendationFor("information about the 'init' task", "build_init_plugin"))
            .append("\n\n")
            // this is the "build script basics" chapter, we're missing some kind of "how to write a Gradle build chapter"

=====
[source, groovy]
----
.
├── app
│   ...
│   └── build.gradle
└── settings.gradle
----
=====

This is the recommended project structure for starting any Gradle project.
The <<build_init_plugin#build_init_plugin,build init plugin>> also generates skeleton projects that follow this structure - a root project with a single subproject:

The `settings.gradle(.kts)` file describes the project structure to Gradle:

====

            output.println();
            output.println();
            output.append("For more detail on the 'init' task, see ");
            output.withStyle(UserInput).append(getDocumentationRegistry().getDocumentationFor("build_init_plugin"));
            output.println();
            output.println();
            output.append("For more detail on creating a Gradle build, see ");

platforms/documentation/docs/src/docs/userguide/core-plugins/build_dashboard_plugin.adoc      @gradle/bt-devrel-education @gradle/bt-jvm
platforms/documentation/docs/src/docs/userguide/core-plugins/build_init_plugin.adoc           @gradle/bt-devrel-education @gradle/bt-jvm
platforms/documentation/docs/src/docs/userguide/core-plugins/checkstyle_plugin.adoc           @gradle/bt-devrel-education @gradle/bt-jvm

Welcome to Gradle ${version}.

Directory '$testDirectory' does not contain a Gradle build.

To create a new build in this directory, run gradle init

For more detail on the 'init' task, see $BASE_URL/userguide/build_init_plugin.html

For more detail on creating a Gradle build, see $BASE_URL/userguide/tutorial_using_tasks.html

To see a list of command-line options, run gradle --help