classicvalues / teamsfx

Developer tools for building Teams apps

Microsoft Teams Toolkit

Teams Toolkit for Visual Studio, Visual Studio Code, and Command Line Interface (CLI) are tools for building Teams apps, fast. Whether you are new to Teams platform or a seasoned developer, Teams Toolkit is the best way to create, build, debug, test, and deploy apps.

Teams Toolkit provides support for the end-to-end Teams development journey, including:

• Support for all major Teams extensibility surfaces, including tabs, bots, and message extensions.
• Integrations with the tools, languages, and frameworks you know and love.
• Scaffolds for getting started fast with Teams extensibility surfaces and common scenarios such as notifications and command & response-style bots.
• Rapid iteration with full stack debugging, hot reload, and secure tunneling.
• Simplified SSO authentication.
• Integrated support for hosting, data storage, and serverless functions.
• CI/CD actions for GitHub and Azure DevOps to deliver apps with confidence.

Get Started

Pick your preferred tool to get started:

• For JavaScript and TypeScript developers, install Teams Toolkit for Visual Studio Code.
• For .NET developers, install Teams Toolkit for Visual Studio.
• For command line users, install Teams Toolkit CLI: npm install -g @microsoft/teamsfx-cli

Visit Microsoft Teams developer documentation to get started with building apps with Teams Toolkit today.

Roadmap

Teams Toolkit for Visual Studio, Visual Studio Code, and Command Line Interface (CLI) will be updated regularly with new features and bug fixes to continuously improve end-to-end Teams development experience. Visit our product roadmap to find out what's coming.

Support Policy

Teams Toolkit products will follow Modern Lifecycle Policy and extended support as described in our lifecycle and support document.

Feedback

• Ask a question on Stack Overflow
• Request a new feature
• File an issue
• Send an email to [email protected] to chat with the product team
• Report security issues and bugs to the Microsoft Security Response Center (MSRC) via [email protected]. Further information can be found in the Security TechCenter.

Repository

This repository contains the following packages:

Package	Description
Teams Toolkit for Visual Studio Code packages/vscode-extension	Teams Toolkit for Visual Studio Code enables you to scaffold, run, debug, and deploy custom Teams apps directly from Visual Studio Code. It provides all the features of the Teams Toolkit CLI tool integrated into the IDE, as well as easy access to more samples, docs and tools.
Teams Toolkit CLI packages/cli	Whether you prefer keyboard-centric developer operations, or you are automating your CI/CD pipeline, the Teams Toolkit CLI tool offers the same features as the IDE extensions.
SDK packages/sdk	The main code library encapsulating simple authentication for both client and server-side code tailored for Teams developers.
API packages/api	The API package is a collection of contracts supported by the IDE Extensions and CLI. It enables developers to write plugins to extend TeamsFx with new capabilities.
Core packages/fx-core	The Core package centralizes implementation of capabilities shared by the IDE Extensions and the CLI.
Azure Functions Support packages/function-extension	Teams Toolkit helps developers include server-side code in their Teams application backed by Azure Functions. This plugin adds support to simplify the integration of an authentication-aware Azure Function into your Teams app.

Contributions

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 Contributor License Agreement.

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., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

• Download our latest daily Builds here
• Check out our contribution page for more information

Telemetry

Teams Toolkit collects usage data and sends it to Microsoft to help improve our products and services. Read our Privacy Statement and Data Collection Notice to learn more. Learn more in our FAQ.

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.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.