# Microsoft 365 Agents Toolkit CLI (Command Line Tool)

Microsoft 365 Agents Toolkit CLI is a text-based command line interface that can help scaffold, validate, and deploy applications for Microsoft 365 from the terminal or a CI/CD process.

![CLI](https://aka.ms/cli-hero-image)

## Getting Started

Let's start by installing `@microsoft/m365agentstoolkit-cli` from NPM and run `atk -h` to check all available commands:

```powershell
$ npm install -g @microsoft/m365agentstoolkit-cli
$ atk -h
```

> [!NOTE]
> Please refer to [Microsoft 365 Agents Toolkit CLI Documentation](https://aka.ms/teamsfx-toolkit-cli) for in-depth instructions.

## Feedback

- Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/teams-toolkit)
- [Request a new feature](https://github.com/OfficeDev/TeamsFx/issues/new?assignees=&labels=&template=feature_request.md&title=)
- [File an issue](https://github.com/OfficeDev/TeamsFx/issues/new?assignees=&labels=&template=bug_report.md&title=)
- Send an email to ttkfeedback@microsoft.com to chat with the product team
- Report security issues and bugs to the Microsoft Security Response Center (MSRC) via secure@microsoft.com. Further information can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue?rtc=1).

## 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=824704. 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.

### Telemetry Configuration

Telemetry collection is on by default. To opt out, please add the global option `--telemetry false` for each command to turn it off.

## Code of Conduct

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.


## Contributing

There are many ways in which you can participate in the project, for example:

- [Submit bugs and feature requests](https://github.com/OfficeDev/TeamsFx/issues), and help us verify as they are checked in
- Review [source code changes](https://github.com/OfficeDev/TeamsFx/pulls)
- Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/teams-toolkit)
- Send an email to ttkfeedback@microsoft.com to chat with the product team
- Report security issues and bugs to the Microsoft Security Response Center (MSRC) via secure@microsoft.com. Further information can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue?rtc=1).

If you are interested in fixing issues and contributing directly to the code base, please see the [Contributing Guide](./CONTRIBUTING.md).

## Additional References

* [Source code](https://github.com/OfficeDev/teams-toolkit/tree/dev/packages/cli)
* [Package (NPM)](https://www.npmjs.com/package/@microsoft/m365agentstoolkit-cli)
* [Official Documentation](https://aka.ms/teamsfx-toolkit-cli)

## 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](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). 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

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the [MIT](LICENSE.txt) license.
