-
Notifications
You must be signed in to change notification settings - Fork 293
Update readme #6625
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update readme #6625
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ddbce12
add pointer to agents.md
kristenwomack 2fbc12e
update details
kristenwomack 7588ef3
update agent pointer
kristenwomack 10e3546
Fix README link to point to cli/azd/AGENTS.md (#6639)
Copilot cd07c4b
Align README tagline with build-deploy-operate terminology (#6638)
Copilot 0816f9e
Add MIT license reference to README (#6645)
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,129 +1,135 @@ | ||
| # Azure Developer CLI | ||
| # Azure Developer CLI (`azd`) | ||
|
|
||
| Latest builds: | ||
| > **From code to cloud in minutes.** A developer-centric CLI to build, deploy, and operate Azure applications. | ||
|
|
||
| | Artifact | Version | Download | | ||
| | ------- | ------- | -------- | | ||
| | azd |  | [Windows](https://azuresdkartifacts.z5.web.core.windows.net/azd/standalone/latest/azd-windows-amd64.zip) | [Linux](https://azuresdkartifacts.z5.web.core.windows.net/azd/standalone/latest/azd-linux-amd64.tar.gz) | [Mac](https://azuresdkartifacts.z5.web.core.windows.net/azd/standalone/latest/azd-darwin-amd64.zip) | | ||
| | vscode extension |  | [VSIX](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.azure-dev) | | ||
| [](https://github.com/Azure/azure-dev/releases) | ||
| [](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.azure-dev) | ||
| [](https://github.com/Azure/azure-dev/discussions) | ||
|
|
||
| The Azure Developer CLI (`azd`) is a developer-centric command-line interface (CLI) tool for creating Azure applications. The goals of the CLI are to: | ||
| --- | ||
|
|
||
| - reduce the time required for a developer to be productive | ||
| - demonstrate opinionated best practices for Azure development | ||
| - help developers understand core Azure development constructs | ||
| ## Built for you | ||
|
|
||
| To take full advantage of the CLI, code repositories need to conform to a well defined set of conventions that will be recognized by the tooling. Please checkout the [docs](https://aka.ms/azd) for more information and to get started. Use [discussions](https://github.com/Azure/azure-dev/discussions) to participate in the conversation, ask questions, and see the latest announcements. | ||
| - ⚡ **Get productive fast** — Streamlined workflows to go from code to cloud in minutes | ||
| - 🏗️ **Azure recommended practices built-in** — Opinionated templates that follow Azure development standards | ||
| - 🧠 **Learn as you build** — Understand core Azure constructs through hands-on experience | ||
|
|
||
| ## Install/Upgrade Azure Developer CLI | ||
| 📖 **[Get Started](https://aka.ms/azd)** · 💬 **[Join the Discussion](https://github.com/Azure/azure-dev/discussions)** · 📦 **[Browse Templates](https://azure.github.io/awesome-azd/)** | ||
|
|
||
| Install and upgrade using the following scripts. Re-running the script will install the latest available version. | ||
| --- | ||
|
|
||
| For advanced install scenarios see [Azure Developer CLI Installer Scripts](cli/installer/README.md). | ||
| ## Downloads | ||
|
|
||
| ### Windows | ||
| | Artifact | Version | Download | | ||
| | -------- | ------- | -------- | | ||
| | CLI |  | [Windows](https://azuresdkartifacts.z5.web.core.windows.net/azd/standalone/latest/azd-windows-amd64.zip) · [Linux](https://azuresdkartifacts.z5.web.core.windows.net/azd/standalone/latest/azd-linux-amd64.tar.gz) · [macOS](https://azuresdkartifacts.z5.web.core.windows.net/azd/standalone/latest/azd-darwin-amd64.zip) | | ||
| | VS Code Extension |  | [Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.azure-dev) | | ||
|
|
||
| #### Windows Package Manager (winget) | ||
| ## 🤖 AI Agents | ||
|
|
||
| ```powershell | ||
| winget install microsoft.azd | ||
| ``` | ||
| **Contributing to this repo?** See [AGENTS.md](cli/azd/AGENTS.md) for coding standards and guidelines. | ||
|
|
||
| #### Chocolatey | ||
| **Using `azd` with an AI coding assistant?** Check out the [docs](https://aka.ms/azd) and [templates](https://azure.github.io/awesome-azd/). | ||
|
|
||
| ```powershell | ||
| choco install azd | ||
| ``` | ||
| --- | ||
|
|
||
| #### Install script | ||
| ## Installation | ||
|
|
||
| Install or upgrade to the latest version. For advanced scenarios, see the [installer docs](cli/installer/README.md). | ||
|
|
||
| ### Windows | ||
|
|
||
| ```powershell | ||
| # Using winget (recommended) | ||
| winget install microsoft.azd | ||
|
|
||
| # Or Chocolatey | ||
| choco install azd | ||
|
|
||
| # Or install script | ||
| powershell -ex AllSigned -c "Invoke-RestMethod 'https://aka.ms/install-azd.ps1' | Invoke-Expression" | ||
| ``` | ||
| ### MacOS | ||
|
|
||
| #### Homebrew | ||
| ### macOS | ||
|
|
||
| ```bash | ||
| brew tap azure/azd && brew install azd | ||
| ``` | ||
|
|
||
| If using `brew` to upgrade `azd` from a version not installed using `brew`, remove the existing version of `azd` using the uninstall script (if installed to the default location) or by deleting the `azd` binary manually. | ||
| > **Note:** If upgrading from a non-Homebrew installation, remove the existing `azd` binary first. | ||
|
|
||
| ### Linux | ||
|
|
||
| ``` | ||
| ```bash | ||
| curl -fsSL https://aka.ms/install-azd.sh | bash | ||
| ``` | ||
|
|
||
| ## Set Up Shell Completion | ||
| ### Shell Completion | ||
|
|
||
| The CLI supports shell completion for `bash`, `zsh`, `fish` and `powershell`. | ||
| Enable tab completion for `bash`, `zsh`, `fish`, or `powershell`: | ||
|
|
||
| To learn how to install shell completion for the CLI for your shell, run `azd completion [bash | zsh | fish | powershell] --help`. | ||
| For example, to get the instructions for `bash` run `azd completion bash --help` | ||
| ```bash | ||
| azd completion <shell> --help | ||
| ``` | ||
|
|
||
| ## Uninstall Azure Developer CLI | ||
| --- | ||
|
|
||
| ### Windows | ||
| ## Uninstall | ||
|
|
||
| #### Uninstalling 0.5.0-beta.1 and later | ||
| <details> | ||
| <summary><strong>Windows</strong></summary> | ||
|
|
||
| The Azure Developer CLI uses MSI to install on Windows. Use the "Add or remove programs" dialog in Windows to remove the "Azure Developer CLI" application. If installed using a package manager like winget or choco, uninstall using the package manager's uninstall command. | ||
| - **v0.5.0+**: Use "Add or remove programs" or your package manager (`winget uninstall`, `choco uninstall`) | ||
| - **v0.4.0 and earlier**: | ||
| ```powershell | ||
| powershell -ex AllSigned -c "Invoke-RestMethod 'https://aka.ms/uninstall-azd.ps1' | Invoke-Expression" | ||
| ``` | ||
|
|
||
| #### Uninstalling version 0.4.0-beta.1 and earlier | ||
| </details> | ||
|
|
||
| Use this PowerShell script to uninstall Azure Developer CLI 0.4.0-beta.1 and earlier. | ||
| <details> | ||
| <summary><strong>Linux / macOS</strong></summary> | ||
|
|
||
| ```powershell | ||
| powershell -ex AllSigned -c "Invoke-RestMethod 'https://aka.ms/uninstall-azd.ps1' | Invoke-Expression" | ||
| ```bash | ||
| curl -fsSL https://aka.ms/uninstall-azd.sh | bash | ||
| ``` | ||
|
|
||
| ### Linux/MacOS | ||
| Or use your package manager's uninstall command. | ||
|
|
||
| If installed using the script, uninstall using this script. | ||
| </details> | ||
|
|
||
| ``` | ||
| curl -fsSL https://aka.ms/uninstall-azd.sh | bash | ||
| ``` | ||
|
|
||
| If installed using a package manager, uninstall using the package manager's uninstall command. | ||
| --- | ||
|
|
||
| ## Data Collection | ||
|
|
||
| The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkId=521839. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. | ||
| This software may collect usage data and send it to Microsoft to help improve our products. You can opt out by setting: | ||
|
|
||
| ### Telemetry Configuration | ||
| ```bash | ||
| export AZURE_DEV_COLLECT_TELEMETRY=no | ||
| ``` | ||
|
|
||
| Telemetry collection is on by default. | ||
| See the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839) for details. | ||
|
|
||
| To opt out, set the environment variable `AZURE_DEV_COLLECT_TELEMETRY` to `no` in your environment. | ||
| --- | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
| the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
| We welcome contributions! Please see our [contributing guide](cli/azd/CONTRIBUTING.md) for details. | ||
|
|
||
| When you submit a pull request, a CLA-bot will automatically determine whether you need to provide | ||
| a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions | ||
| provided by the bot. You will only need to do this once across all repos using our CLA. | ||
| Most contributions require a [Contributor License Agreement (CLA)](https://cla.microsoft.com). A bot will guide you through this when you open a PR. | ||
|
|
||
| Please see our [contributing guide](cli/azd/CONTRIBUTING.md) for complete instructions on how you can contribute to the Azure Developer CLI. | ||
| This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). Questions? Contact [opencode@microsoft.com](mailto:opencode@microsoft.com). | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
| ### Template Authors | ||
|
|
||
| ### Contributing as Microsoft template author | ||
| Microsoft employees and partners contributing official templates should follow the [template standardization guidelines](https://github.com/Azure-Samples/azd-template-artifacts). | ||
|
|
||
| Microsoft employees and partners who want to contribute templates to our official collections, must follow the standardization guidelines for template scaffolding and validation published [here](https://github.com/Azure-Samples/azd-template-artifacts) | ||
| --- | ||
|
|
||
| *Important Disclaimer*: The standardization artifacts, definitions, and recommendations are frequently updated. Please make sure to visit the site often to follow the latest recommended practices. | ||
| ## Trademarks | ||
|
|
||
| ## Trademark Notice | ||
| This project may contain Microsoft trademarks or logos. Use of these must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks). Third-party trademarks are subject to their respective policies. | ||
|
|
||
| Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies. | ||
| ## License | ||
|
kristenwomack marked this conversation as resolved.
|
||
|
|
||
| ## License - Azure Developer CLI Templates Trust Notice | ||
| Learn more about running third-party code on [our DevHub](https://learn.microsoft.com/azure/developer/azure-developer-cli/azd-templates#guidelines-for-using-azd-templates) | ||
| Licensed under the [MIT](LICENSE) license. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.