The current CLI commands are detailed below for reference. They are accessed using your command line/terminal tool via the dotnet command using the ef switch. The full list of commands can be accessed from within the command line by typing dotnet ef --help:
language-cmd
|
Usage: dotnet ef [options] [command]
Options:
--version Show version information
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
Commands:
database Commands to manage the database.
dbcontext Commands to manage DbContext types.
migrations Commands to manage migrations.
Use "dotnet ef [command] --help" for more information about a command.
Database
language-cmd
|
Usage: dotnet ef database [options] [command]
Options:
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
Commands:
drop Drops the database.
update Updates the database to a specified migration.
Use "database [command] --help" for more information about a command.
database drop
language-cmd
|
Usage: dotnet ef database drop [options]
Options:
-f|--force Don't confirm.
--dry-run Show which database would be dropped, but don't drop it.
-c|--context <DBCONTEXT> The DbContext to use.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
database update
language-cmd
|
Usage: dotnet ef database update [arguments] [options]
Arguments:
<MIGRATION> The target migration. If '0', all migrations will be reverted. Defaults to the last migration.
Options:
-c|--context <DBCONTEXT> The DbContext to use.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
DbContext
language-cmd
|
Usage: dotnet ef dbcontext [options] [command]
Options:
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
Commands:
info Gets information about a DbContext type.
list Lists available DbContext types.
scaffold Scaffolds a DbContext and entity types for a database.
Use "dbcontext [command] --help" for more information about a command.
dbcontext info
language-cmd
|
Usage: dotnet ef dbcontext info [options]
Options:
--json Show JSON output.
-c|--context <DBCONTEXT> The DbContext to use.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
dbcontext list
language-cmd
|
Usage: dotnet ef dbcontext list [options]
Options:
-e|--environment <environment> The environment to use. If omitted, "Development" is used.
--json Use json output. JSON is wrapped by '//BEGIN' and '//END'
-h|--help Show help information
-v|--verbose Enable verbose output
dbcontext scaffold
language-cmd
|
Usage: dotnet ef dbcontext scaffold [arguments] [options]
Arguments:
<CONNECTION> The connection string to the database.
<PROVIDER> The provider to use. (E.g. Microsoft.EntityFrameworkCore.SqlServer)
Options:
-d|--data-annotations Use attributes to configure the model (where possible). If omitted, only the fluent API is used.
-c|--context <NAME> The name of the DbContext.
-f|--force Overwrite existing files.
-o|--output-dir <PATH> The directory to put files in. Paths are relative to the project directory.
--schema <SCHEMA_NAME>... The schemas of tables to generate entity types.
-t|--table <TABLE_NAME>... The tables to generate entity types for.
--json Show JSON output.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
Migrations
language-cmd
|
Usage: dotnet ef migrations [options] [command]
Options:
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
Commands:
add Adds a new migration.
list Lists available migrations.
remove Removes the last migration.
script Generates a SQL script from migrations.
Use "migrations [command] --help" for more information about a command.
migrations add
language-cmd
|
Usage: dotnet ef migrations add [arguments] [options]
Arguments:
<NAME> The name of the migration.
Options:
-o|--output-dir <PATH> The directory (and sub-namespace) to use. Paths are relative to the project directory. Defaults to "Migrations".
--json Show JSON output.
-c|--context <DBCONTEXT> The DbContext to use.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
migrations list
language-cmd
|
Usage: dotnet ef migrations list [options]
Options:
--json Show JSON output.
-c|--context <DBCONTEXT> The DbContext to use.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
migrations remove
language-cmd
|
Usage: dotnet ef migrations remove [options]
Options:
-f|--force Don't check to see if the migration has been applied to the database.
--json Show JSON output.
-c|--context <DBCONTEXT> The DbContext to use.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
migrations script
language-cmd
|
Usage: dotnet ef migrations script [arguments] [options]
Arguments:
<FROM> The starting migration. Defaults to '0' (the initial database).
<TO> The ending migration. Defaults to the last migration.
Options:
-o|--output <FILE> The file to write the result to.
-i|--idempotent Generate a script that can be used on a database at any migration.
-c|--context <DBCONTEXT> The DbContext to use.
-p|--project <PROJECT> The project to use.
-s|--startup-project <PROJECT> The startup project to use.
--framework <FRAMEWORK> The target framework.
--configuration <CONFIGURATION> The configuration to use.
--msbuildprojectextensionspath <PATH> The MSBuild project extensions path. Defaults to "obj".
-e|--environment <NAME> The environment to use. Defaults to "Development".
-h|--help Show help information
-v|--verbose Show verbose output.
--no-color Don't colorize the output.
--prefix-output Prefix output with level.
FAQ Chat