Reference
Version · 6.0
Change Automation Reference

init project

Last updated: October 7, 2026

As a new user, run the init project subcommand to get started with Liquibase. If you already use Liquibase, run init project to immediately create a new project with minimal input. It is available in Liquibase 4.7.0 and later.

The subcommand finds or creates your project folder containing a changelog and “defaults file”—liquibase.properties—and delivers an example H2 database to help you get started. The defaults file lets you specify properties without typing them into the CLI every time you run a command.

init project generates eight policy check package YAML files in a checks-packages/ subdirectory. This contains six themed packages and two composite packages. See What are the default policy check packages?.

Syntax

To run the init project subcommand in the interactive mode, enter liquibase init project in your command line and follow the instructions: choose [y] to accept all the default values, [c] to customize the values, or [n] to not set up the project files.

Note: The project subcommand can be replaced by its alias which is project-new. Example: init project-new

Liquibase provides the following options:

Keep the default settings (y)

--project-dir=./
--changelog-file=example-changelog.sql
--format=sql
--project-defaults-file=liquibase.properties
--url=jdbc:h2:tcp://localhost:9090/mem:dev
--username=dbuser
--password=letmein

The default values work with the example H2 database, which is also delivered when running liquibase init project.

Customize all parameters (c)

--project-dir=[path/to/some/directory]
--changelog-file=[file.ext]
--format=[sql|xml|json|yaml|yml]
--project-defaults-file=[liquibase.properties]
--url=[some/JDBC/URL]
--username=[string]
--password=[string]

Customize a few parameters and stop the process. The default settings will be used.

Example: If you run liquibase init project --changelog-file=mychangelog.sql --username=myusername, the interactive mode will ask if you want to accept the rest of the default parameters or customize all flags that are not set. In this case, they are project dir, project defaults file, url, and password

To use the non-interactive mode, run liquibase init project and specify all the parameters you need:

liquibase init project
--project-dir=[path/to/some/directory]
--changelog-file=[file.ext]
--format=[sql|xml|json|yaml|yml]
--project-defaults-file=[liquibase.properties]
--url=[some/JDBC/URL]
--username=[string]
--password=[string]

Note: If Liquibase cannot find the directory, it will create the directory using the path you have specified.

init project does not overwrite your existing changelog file but updates an existing project-defaults-file with the same name. For example, this functionality might help you update the Liquibase properties file from the CLI with a different changelog or URL, but keep other values and files the same.

Command parameters

Attribute	Description	Requirements
`--changelog-file=<string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`--format=<string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`--keep-temp-files=<true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`--password=<string>`	Password to use to connect to the database. Default: `letmein`	Optional
`--project-defaults-file=<string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`--project-dir=<string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`--project-guide=<string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`--url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`--username=<string>`	Username to connect to the database. Default: `dbuser`	Optional

Attribute	Description	Requirements
`cmdArgs: { changelog-file: "<string>" }`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`cmdArgs: { format: "<string>" }`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`cmdArgs: { keep-temp-files: "<true\|false>" }`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`cmdArgs: { password: "<string>" }`	Password to use to connect to the database. Default: `letmein`	Optional
`cmdArgs: { project-defaults-file: "<string>" }`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`cmdArgs: { project-dir: "<string>" }`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`cmdArgs: { project-guide: "<string>" }`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`cmdArgs: { url: "<string>" }`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`cmdArgs: { username: "<string>" }`	Username to connect to the database. Default: `dbuser`	Optional

Attribute	Description	Requirements
`liquibase.command.changelogFile: <string>` `liquibase.command.init.project.changelogFile: <string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`liquibase.command.format: <string>` `liquibase.command.init.project.format: <string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`liquibase.command.keepTempFiles: <true\|false>` `liquibase.command.init.project.keepTempFiles: <true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`liquibase.command.password: <string>` `liquibase.command.init.project.password: <string>`	Password to use to connect to the database. Default: `letmein`	Optional
`liquibase.command.projectDefaultsFile: <string>` `liquibase.command.init.project.projectDefaultsFile: <string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`liquibase.command.projectDir: <string>` `liquibase.command.init.project.projectDir: <string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`liquibase.command.projectGuide: <string>` `liquibase.command.init.project.projectGuide: <string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`liquibase.command.url: <string>` `liquibase.command.init.project.url: <string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`liquibase.command.username: <string>` `liquibase.command.init.project.username: <string>`	Username to connect to the database. Default: `dbuser`	Optional

Attribute	Description	Requirements
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.changelogFile=<string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`JAVA_OPTS=-Dliquibase.command.format=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.format=<string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`JAVA_OPTS=-Dliquibase.command.keepTempFiles=<true\|false>` `JAVA_OPTS=-Dliquibase.command.init.project.keepTempFiles=<true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`JAVA_OPTS=-Dliquibase.command.password=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.password=<string>`	Password to use to connect to the database. Default: `letmein`	Optional
`JAVA_OPTS=-Dliquibase.command.projectDefaultsFile=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.projectDefaultsFile=<string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`JAVA_OPTS=-Dliquibase.command.projectDir=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.projectDir=<string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`JAVA_OPTS=-Dliquibase.command.projectGuide=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.projectGuide=<string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`JAVA_OPTS=-Dliquibase.command.username=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.username=<string>`	Username to connect to the database. Default: `dbuser`	Optional

`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_CHANGELOG_FILE=<string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`LIQUIBASE_COMMAND_FORMAT=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_FORMAT=<string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`LIQUIBASE_COMMAND_KEEP_TEMP_FILES=<true\|false>` `LIQUIBASE_COMMAND_INIT_PROJECT_KEEP_TEMP_FILES=<true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`LIQUIBASE_COMMAND_PASSWORD=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PASSWORD=<string>`	Password to use to connect to the database. Default: `letmein`	Optional
`LIQUIBASE_COMMAND_PROJECT_DEFAULTS_FILE=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_DEFAULTS_FILE=<string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`LIQUIBASE_COMMAND_PROJECT_DIR=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_DIR=<string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`LIQUIBASE_COMMAND_PROJECT_GUIDE=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_GUIDE=<string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_URL=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`LIQUIBASE_COMMAND_USERNAME=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_USERNAME=<string>`	Username to connect to the database. Default: `dbuser`	Optional

Attribute	Description	Requirements
`--changelog-file=<string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`--format=<string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`--keep-temp-files=<true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`--password=<string>`	Password to use to connect to the database. Default: `letmein`	Optional
`--project-defaults-file=<string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`--project-dir=<string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`--project-guide=<string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`--url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`--username=<string>`	Username to connect to the database. Default: `dbuser`	Optional

Attribute	Description	Requirements
`cmdArgs: { changelog-file: "<string>" }`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`cmdArgs: { format: "<string>" }`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`cmdArgs: { keep-temp-files: "<true\|false>" }`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`cmdArgs: { password: "<string>" }`	Password to use to connect to the database. Default: `letmein`	Optional
`cmdArgs: { project-defaults-file: "<string>" }`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`cmdArgs: { project-dir: "<string>" }`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`cmdArgs: { project-guide: "<string>" }`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`cmdArgs: { url: "<string>" }`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`cmdArgs: { username: "<string>" }`	Username to connect to the database. Default: `dbuser`	Optional

Attribute	Description	Requirements
`liquibase.command.changelogFile: <string>` `liquibase.command.init.project.changelogFile: <string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`liquibase.command.format: <string>` `liquibase.command.init.project.format: <string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`liquibase.command.keepTempFiles: <true\|false>` `liquibase.command.init.project.keepTempFiles: <true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`liquibase.command.password: <string>` `liquibase.command.init.project.password: <string>`	Password to use to connect to the database. Default: `letmein`	Optional
`liquibase.command.projectDefaultsFile: <string>` `liquibase.command.init.project.projectDefaultsFile: <string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`liquibase.command.projectDir: <string>` `liquibase.command.init.project.projectDir: <string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`liquibase.command.projectGuide: <string>` `liquibase.command.init.project.projectGuide: <string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`liquibase.command.url: <string>` `liquibase.command.init.project.url: <string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`liquibase.command.username: <string>` `liquibase.command.init.project.username: <string>`	Username to connect to the database. Default: `dbuser`	Optional

Attribute	Description	Requirements
`JAVA_OPTS=-Dliquibase.command.changelogFile=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.changelogFile=<string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`JAVA_OPTS=-Dliquibase.command.format=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.format=<string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`JAVA_OPTS=-Dliquibase.command.keepTempFiles=<true\|false>` `JAVA_OPTS=-Dliquibase.command.init.project.keepTempFiles=<true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`JAVA_OPTS=-Dliquibase.command.password=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.password=<string>`	Password to use to connect to the database. Default: `letmein`	Optional
`JAVA_OPTS=-Dliquibase.command.projectDefaultsFile=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.projectDefaultsFile=<string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`JAVA_OPTS=-Dliquibase.command.projectDir=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.projectDir=<string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`JAVA_OPTS=-Dliquibase.command.projectGuide=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.projectGuide=<string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`JAVA_OPTS=-Dliquibase.command.url=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.url=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`JAVA_OPTS=-Dliquibase.command.username=<string>` `JAVA_OPTS=-Dliquibase.command.init.project.username=<string>`	Username to connect to the database. Default: `dbuser`	Optional

`LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_CHANGELOG_FILE=<string>`	Relative or fully qualified path to the changelog file. Default: `example-changelog`	Optional
`LIQUIBASE_COMMAND_FORMAT=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_FORMAT=<string>`	Format of the project changelog file: `sql\|xml\|json\|yaml\|yml`. Default: `sql`	Optional
`LIQUIBASE_COMMAND_KEEP_TEMP_FILES=<true\|false>` `LIQUIBASE_COMMAND_INIT_PROJECT_KEEP_TEMP_FILES=<true\|false>`	For remote project locations, do not delete temporary project files. Default: `false`	Optional
`LIQUIBASE_COMMAND_PASSWORD=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PASSWORD=<string>`	Password to use to connect to the database. Default: `letmein`	Optional
`LIQUIBASE_COMMAND_PROJECT_DEFAULTS_FILE=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_DEFAULTS_FILE=<string>`	File with default Liquibase properties. Default: `liquibase.properties`	Optional
`LIQUIBASE_COMMAND_PROJECT_DIR=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_DIR=<string>`	An optional parameter used to specify the directory containing files (existing or to be auto-created) to be used with Liquibase. Default: `./`	Optional
`LIQUIBASE_COMMAND_PROJECT_GUIDE=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_PROJECT_GUIDE=<string>`	Parameter that turns on or turns off the CLI interactive mode. For example, if you want to set one parameter and have the rest as default ones, run the parameter and set `--project-guide=off` to not be asked about the rest of the settings: `liquibase init project --changelog=mychangelog.sql --project-guide=off`. Default: `on`	Optional
`LIQUIBASE_COMMAND_URL=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_URL=<string>`	The JDBC database connection URL. See Using JDBC URL in Liquibase. Default: `jdbc:h2:tcp://localhost:9090/mem:dev`	Optional
`LIQUIBASE_COMMAND_USERNAME=<string>` `LIQUIBASE_COMMAND_INIT_PROJECT_USERNAME=<string>`	Username to connect to the database. Default: `dbuser`	Optional

Troubleshooting

Commercial dependency bug

PreviousWhat are init commands?NextInit start-h2

init project

Syntax

Keep the default settings (y)

Customize all parameters (c)

To use the non-interactive mode, run liquibase init project and specify all the parameters you need:

Command parameters

CLI

Flow

liquibase.properties

JAVA OPTS

Environment variable

Troubleshooting

Commercial dependency bug