How to watch for file changes "dotnet watch" with Visual Studio ASP.NET Core

Question

I am using Visual Studio with ASP.NET Core and run the website using just F5 or Ctrl+F5 (not using the command line directly). I would like to use the "dotnet watch" functionality to make sure all changes are picked up on the fly to avoid starting the server again. It seems that with the command line you would use "dotnet watch run" for this, but Visual Studio uses launchSettings.json and does it behind the scenes if I understand it correctly.

How can I wire up "dotnet watch" there?

I think you have the wrong impression of "watch" functionality. When you change a file your application **will** be restarted and having to warm up again on first request or populate it's cache (as the in memory cached content get losts when it restarts) — Tseng, Oct 20 '16 at 11:31
Well, I really meant without having a need to "manually restart" the application. So I do understand that it's not some magic on the fly, which would be nice to have similar to the cshtml views recompilation that does not restart the whole application. — Ilya Chernomordik, Oct 20 '16 at 11:41

score 59 · Answer 1 · edited Oct 23 '21 at 16:51

59

If you want to use ASP.NET 2.x or 3.x you need to change it a bit.

The watch tool is a global tool now and you don't need to add it as a reference any longer

The syntax is slightly different

"Watch": {
  "executablePath": "dotnet.exe",
  "workingDirectory": "$(ProjectDir)",
  "commandLineArgs": "watch run",
  "launchBrowser": true,
  "launchUrl": "http://localhost:5000/",
  "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Development"
  }
}

For .Net 5 & 6

In VisualStudio 2019

Go to Tools > ⚙ Options > Projects and Solutions > ASP .NET Core
Select Auto build and refresh browser after saving changes in Auto build and refresh option
Press Ctrl + F5 (Start Without Debugging) IMPORTANT: Only works if run without debbuging

Otherwise add this to your launchSettings.json:

{
  "iisSettings": {
    ...
  },
  "profiles": {
    ... ,

    "Watch": {
      "commandName": "Executable",
      "executablePath": "dotnet.exe",
      "workingDirectory": "$(ProjectDir)",
      "commandLineArgs": "watch run"
    }

  }
}

The automatically generated profile with "commandName":"Project" has all the other properties needed: launchBrowser, applicationUrl, environmentVariables, dotnetRunMessages and hotReloadProfile. Any modifications should be made there.

Corresponding Blog-Post from Juan Cruz Fiant: https://dev.to/juxant/auto-refresh-with-dotnet-watch-for-asp-net-core-projects-20no

edited Oct 23 '21 at 16:51

Zoe

27,060
21
118
148

answered Nov 09 '18 at 11:39

Michael A. Volz aka Flynn

1,755
3
19
34

2

This locked my c# files, while running, I cannot edit files, any clues? – Ayyash Nov 20 '18 at 09:52
@Ayyash I am using this all the time. Without any problems. I have 2.2 Preview3 installed. What extactly do you mean by "can not edit files"? – Michael A. Volz aka Flynn Nov 20 '18 at 20:12
I think i was running in debug mode, which locks the files, there is another option to start without debugging, right? I forgot its been a long time since I worked with it – Ayyash Nov 22 '18 at 08:23
Probably you have Edit and Continue disabled? https://learn.microsoft.com/en-us/visualstudio/debugger/edit-and-continue?view=vs-2017 – Piedone Nov 23 '18 at 22:48
2

This worked however I had to change the relative project path to go up 3 directories instead of 4. Eg: `"commandLineArgs": "watch --project ..\\..\\..\\YOUR_PROJECT.csproj run"` – burnt1ce Dec 29 '18 at 18:55
2

If you add `"workingDirectory": "$(ProjectDir)",` you can remove the `--project ...` arg. – DharmaTurtle Mar 21 '19 at 01:53
4

Despite `"launchBrowser": true,` my browser doesn't launch. Does this work for anyone else? – DharmaTurtle Mar 21 '19 at 01:55
4

It won't start the browser for me too. I have to do it manually. – Michael A. Volz aka Flynn Mar 21 '19 at 06:45
1

@Ayyash you need to hit CTRL+F5 not to click "Watch" or F5 – mshwf Jun 01 '19 at 15:37

Shaun Luttin · Accepted Answer · 2016-10-22T04:52:31.313

50

Open launchSettings.json and add this to profiles.

  "Watch": {
    "executablePath": "C:\\Program Files\\dotnet\\dotnet.exe",
    "commandLineArgs": "watch run",
    "launchBrowser": true,
    "launchUrl": "http://localhost:5000",
    "environmentVariables": {
      "ASPNETCORE_ENVIRONMENT": "Development"
    }
  }

Open project.json and add this to tools.

"Microsoft.DotNet.Watcher.Tools": "1.0.0-preview2-final"

After restoring, we can Watch from within Visual Studio.

edited Oct 22 '16 at 04:52

answered Oct 22 '16 at 04:30

Shaun Luttin

133,272
81
405
467

1

Thanks for the answer. It was rather easy after all. Did not guess myself you can just directly use dotnet as from commandline with launchSettings.json :). Though it seems that it does full application restart, which can pretty much be achieved by running behind IIS Express and just building the application. If you do many changes I guess watch will restart on each file save. So the choice should probably depend on what stage of development you are (how often you change stuff). – Ilya Chernomordik Oct 23 '16 at 07:12
Doesn't seem to pick up any changes. Anything else fancy for it to watch the appropriate directory? – Marchy Jan 30 '17 at 05:22
@Marchy What is your directory structure? Where is your `launch.json` file? In other words, what have you tried? It might be worth opening a new question to specify the situation are you are facing. – Shaun Luttin Jan 30 '17 at 18:06
5

When running, it won't let me change any files from the IDE lol. – Matthew James Davis Apr 06 '17 at 10:22
@MatthewJamesDavis What do you mean, exactly? I'm curious. – Shaun Luttin Apr 06 '17 at 19:10
launchSettings are Visual Studio specific. In Visual Studio, I made this change and clicked "Start", which starts debugging. Visual Studio doesn't let you modify C# code while debugging. I can go in VS Code or another editor and make changes, but Visual Studio locks up. I ended up setting up my project exclusively in VS Code because the dev experience in Visual Studio was so sub par. – Matthew James Davis Apr 07 '17 at 09:51
@MatthewJamesDavis I am 100% VSCode these days for a variety of reasons. The chief one is the frequency with which full Visual Studio crashes. – Shaun Luttin Apr 07 '17 at 16:55
3

hi @ShaunLuttin I have tried watcher 2.0.0 with .net core 2.0.3 and it is not working, when I debug the application it will open blank hidden console and application will not launch, have you face any thing like that – programtreasures Dec 03 '17 at 16:22
For a 2021 answer with VS 2019 and .Net 5, you can check my answer below: https://stackoverflow.com/a/66186596/5780536 – Mihai Paraschivescu Feb 13 '21 at 15:41
you forgot to add `"commandName": "Watch",` in the launchsettings watch node... – serge Apr 28 '21 at 21:09

score 18 · Answer 3 · edited Jun 27 '22 at 05:18

Just one little correction to @Flynn`s answer. You need to add an

"commandName": "Executable"

argument to the "Watch" profile. Also to define the urls you should define them not in the "Watch" profile, but in the profile with

"commandName": "Program"

argument (it is present in the default launchsettings.json, created by the Visual Studio project templates, so, your launchsettings.json finally looks like this:

"AnyTest.WebClient": {
  "commandName": "Project",
  "launchBrowser": true,
  "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Development"
  },
  "launchUrl": "",
  "applicationUrl": "https://localhost:44353;http://localhost:51895",
  "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}"
},
"Watch": {
  "commandName": "Executable",
  "workingDirectory": "$(ProjectDir)",
  "executablePath": "dotnet.exe",
  "commandLineArgs": "watch run"
}

I kept the launchBrowser argument in the Program profile, but browser in not launched. But if this argument is present in the Executable profile, the browser is not launched too and I found no way to launch it automatically.

Mihai Paraschivescu · Answer 4 · 2023-03-05T17:59:33.527

16

The accepted answer works, but it's 4+ years old. So here's how you make it work for Visual Studio 2019 (v16.8.5 in my case).

Inside the profiles section of launchSettings.json, you add a new profile, let's say "API Watch", with this content:

"API Watch": {
  "commandName": "Executable",
  "executablePath": "dotnet",
  "commandLineArgs": "watch run",
  "workingDirectory": "$(ProjectDir)",
  "launchBrowser": true,
  "applicationUrl": "https://localhost:5001;http://localhost:5000",
  "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Development"
  },
  "dotnetRunMessages": true
}

And then you go and select it in the Build profiles dropdown:

Now when you run it, regardless if with or without Debug mode on, the re-build and browser refresh (I use the Swagger UI as default page) happens automatically.

One note about using it in Debug mode, is that Visual Studio will mark the changes with green and will say that they won't be applied until a restart happens. I can confirm that this is not true and that the changes are really reflected by the auto rebuild feature of dotnet watch run. It's just that VS 2019 gets confused and treats things from the old (standard) perspective.

edited Mar 05 '23 at 17:59

answered Feb 13 '21 at 15:10

Mihai Paraschivescu

1,261
13
12

Technically the best solution. Thank you. – Paul-Sebastian Manole Apr 21 '21 at 22:41
After many comments and a couple of websites regarding this topic, your answer helped me. Thank you, Mike! – Moises Gonzaga Sep 08 '21 at 22:31
This is the best solution, thanks – Omer Apr 02 '22 at 10:52
@Mihai Paraschivescu ` `"dotnetRunMessages": "true"` or `"dotnetRunMessages": true`. I mean witth `true` in parenthesis or without? – luca88 Mar 04 '23 at 20:08
1

@luca88 without parenthesis, as per the latest docs. I wasn't aware of this since there were no docs for it when I wrote my answer, but now they've clarified it. I will edit my answer to reflect it, thanks. – Mihai Paraschivescu Mar 05 '23 at 09:26

score 11 · Answer 5 · edited May 08 '20 at 01:24

11

"Watch": {
  "commandName": "Project",
  "launchBrowser": true,
  "launchUrl": "http://localhost:5000/",
  "commandLineArgs": "watch run",
  "workingDirectory": "$(ProjectDir)",
  "executablePath": "dotnet.exe",
  "environmentVariables": {
    "ASPNETCORE_ENVIRONMENT": "Development"
  }
}

This one will work and launch the browser too. It works because of the "commandName": "Project" line, which means it will be launching with the Kestrel server.

edited May 08 '20 at 01:24

Jeremy Caney

7,102
69
48
77

answered May 08 '20 at 01:09

Sulav Aryal

136
1
3

1

This should be the accepted answer. VS 2019 v16.10.2. – Meeting Attender Jun 18 '21 at 00:02
launchSettings.json is located in the Properties folder – gl3yn Feb 08 '23 at 07:48

score 3 · Answer 6 · edited Jun 27 '22 at 05:17

3

Open launchSettings.json and add this to profiles.

 "Watch": {
      "executablePath": "dotnet.exe",
      "commandLineArgs": "watch --project ..\\..\\..\\YourProject.csproj run",
      "launchBrowser": true,
      "launchUrl": "http://localhost:5000/",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },

edited Jun 27 '22 at 05:17

Pang

9,564
146
81
122

answered Apr 25 '20 at 12:57

yas17

401
1
3
14

score 3 · Answer 7 · answered Mar 12 '21 at 01:07

To anyone else reading these really old answers and wondering if it is baked-in yet, then you should read this blog post from Nov 22, 2020.

https://dev.to/juxant/auto-refresh-with-dotnet-watch-for-asp-net-core-projects-20no

Visual Studio 2019 now has a setting for ASP.NET Core to refresh when using IIS Express. By default it is not enabled.

You can still use the launchSettings.json files as described in the article.

score 1 · Answer 8 · answered Jan 11 '21 at 11:55

In Visual Studio 2019

{
    "profiles": {
        "msteamsimc": {
        "commandName": "Executable",
        "executablePath": "dotnet",
        "commandLineArgs": "watch run",
        "workingDirectory": "$(ProjectDir)",
        "launchBrowser": true,
        "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development",
        },
        "dotnetRunMessages": "true",
        "applicationUrl": "https://localhost:5001;http://localhost:5000"
    }
    }
}

here an image for confg

here an image for working project 2021-01-11

How to watch for file changes "dotnet watch" with Visual Studio ASP.NET Core

8 Answers8

For .Net 5 & 6

Linked