From 3f4bdd45f45da9af49fb1ef7540e97ca8e995206 Mon Sep 17 00:00:00 2001 From: waldekmastykarz Date: Sat, 3 Oct 2026 15:38:20 +0200 Subject: [PATCH 1/2] Add install and preset quick start to README --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 071f9816..d9db7f6f 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,44 @@ With Dev Proxy you: ## Get started -To get started with Dev Proxy, follow our [tutorial](https://aka.ms/devproxy/start) to install and run Dev Proxy for the first time. +Install Dev Proxy using the command for your operating system. + +**Windows** (after the installation finishes, open a new terminal): + +```bash +winget install DevProxy.DevProxy --silent +``` + +**macOS**: + +```bash +brew tap dotnet/dev-proxy +brew install dev-proxy +``` + +**Linux**: + +```bash +bash -c "$(curl -sL https://aka.ms/devproxy/setup.sh)" +``` + +Download the preset for the API your app calls, and start Dev Proxy with it: + +```bash +devproxy config get github-rate-limiting +devproxy --config-file "~dataFolder/configs/github-rate-limiting/.devproxy/devproxyrc.json" +``` + +API | Preset +----|------- +GitHub | `github-rate-limiting` +OpenAI | `openai-throttling` +Anthropic | `anthropic-throttling` +Microsoft Graph | `microsoft-graph-rate-limiting` + +Run your app as usual. It keeps calling the real API URLs, and Dev Proxy simulates the API's rate limits and errors. Find presets for other APIs in the [samples gallery](https://aka.ms/devproxy/samples). + +For a step-by-step walkthrough, including trusting the Dev Proxy certificate the first time you start it, follow our [tutorial](https://aka.ms/devproxy/start). [![Getting started with Dev Proxy](https://img.youtube.com/vi/HVTJlGSxhcw/0.jpg)](https://www.youtube.com/watch?v=HVTJlGSxhcw) From 485bc117c27499bf1c8268436170afe5d976e23e Mon Sep 17 00:00:00 2001 From: waldekmastykarz Date: Sat, 3 Oct 2026 20:21:17 +0200 Subject: [PATCH 2/2] Clarify Linux post-install and certificate trust steps in README Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d9db7f6f..10b01862 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ brew tap dotnet/dev-proxy brew install dev-proxy ``` -**Linux**: +**Linux** (after the installation finishes, run the `source` command the installer prints, or open a new terminal): ```bash bash -c "$(curl -sL https://aka.ms/devproxy/setup.sh)" @@ -75,9 +75,9 @@ OpenAI | `openai-throttling` Anthropic | `anthropic-throttling` Microsoft Graph | `microsoft-graph-rate-limiting` -Run your app as usual. It keeps calling the real API URLs, and Dev Proxy simulates the API's rate limits and errors. Find presets for other APIs in the [samples gallery](https://aka.ms/devproxy/samples). +The first time you start Dev Proxy, trust its certificate so that it can intercept HTTPS requests. On Linux, you need to trust the certificate manually. Our [tutorial](https://aka.ms/devproxy/start) walks you through these steps. -For a step-by-step walkthrough, including trusting the Dev Proxy certificate the first time you start it, follow our [tutorial](https://aka.ms/devproxy/start). +Then, run your app as usual. It keeps calling the real API URLs, and Dev Proxy simulates the API's rate limits and errors. Find presets for other APIs in the [samples gallery](https://aka.ms/devproxy/samples). [![Getting started with Dev Proxy](https://img.youtube.com/vi/HVTJlGSxhcw/0.jpg)](https://www.youtube.com/watch?v=HVTJlGSxhcw)