The .NET command-line interface (CLI) is a cross-platform toolchain for developing, building, running, and publishing .NET applications.
The .NET CLI is included with the .NET SDK. To learn how to install the .NET SDK, see Install .NET Core.
Full documentation is available at Microsoft’s Docs, this blog post is an overview of the most commonly used CLI commands.
dotnet --infoTo display information about installed SDKs and Runtimes.
dotnet new slnTo create an empty solution. If you don’t provide the name of the solution it will use directory’s name instead and create a solution file.
dotnet new webapi -o apiCreate a new WebApi template project and output in to api folder, -o parameter is used to specify the output directory name
donet sln add .\api\Add the project to the solution. If you just specify the name of the folder it will go and find all the projects inside that folder and add them to the solution.
dotnet sln listIt will list all the projects inside the solution. You must be in the root folder where .sln file exists.
code .To open Visual Studio Code in the current directory.
VS Code will ask you to generate debug assets, click ‘Yes’, if you accidentally miss to click ‘Yes’ you can press Ctrl + Shift + P and type Generate Assets for Build and Debug.
cd api
dotnet runGo to your Api folder and run the api project
dotnet watch runIt will keep an eye on the files changed and automatically recompile the app.
dotnet restoreWill restore the nuget packages.
If you try to access the https endpint it will generate some warnings/errors regarding the self-signed certificate. In the Postman (or similar) you can disable the cert verification (it will give you an option if you make a request to https endpoint) or you can trust your dev cert by running these commands:
dotnet dev-certs httpsWill generate a cert for you or if it is already present it will confirm it’s presence but that does not mean that your OS trusts the cert.
dotnet dev-certs https -tOn windows it will show a warning message and if you select Yes it will entrust the self signed cert.
dotnet dev-certs https --cleanDelete the local cert for development – you will be asked for confirmation
dotnet dev-certs https -tCreate and trust new cert.
Generate & Run Migrations
Install entity framework migration tool, you need to check the runtime version to install entity framework core nuget package. To check the latest runtime version installed on your machine run:
dotnet --infoand then run:
dotnet tool install --global dotnet-ef --version 3.1.9Install nuget package:
Microsoft.EntityFrameworkCore.Design
dotnet ef -hTo list supported commands
dotnet ef migrations add InitialCreate -o Data/MigrationsAdd new migration with output folder specified
dotnet ef database updatedotnet ef database drop -p Infrastructure -s apiDrops the database
dotnet ef migrations remove -p Infrastructure -s apiRemove migrations where infrastructure is the class library having entity framework nuget packages installed.
dotnet ef migrations add InitialiCreate -p Infrastructure -s api -o Data/MigrationsCreates the initial migration inside Data/Migrations folder in Infrastructure class library. (That’s where the dbContext lives)
Test, Build and Release
dotnet build --configuration DebugBuild the application under debug configuration. We can also pass in –configuration Release to build the application for release.
dotnet publish --no-build --configuration Debug --output /folder/of/your/choicePublish the build to the /tmp directory, we can pass in –configuration Release to build the application for release.
dotnet test --configuration Release --no-builddotnet test command to run the unit tests
dotnet test Tailspin.SpaceGame.Web.Tests --configuration Release --no-build --logger trxProvide the –logger option to write the results to a log file
That’s all folks! Happy coding.