Skip to content

Commit

Permalink
Merge pull request #1352 from OfficeDev/nintan/rename-cli
Browse files Browse the repository at this point in the history
fix: rename cli in readme
  • Loading branch information
tecton authored Oct 30, 2024
2 parents 72b5290 + ef91a35 commit bfe0deb
Show file tree
Hide file tree
Showing 47 changed files with 116 additions and 116 deletions.
4 changes: 2 additions & 2 deletions NPM-search-connector-M365/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ NPM Search Connector is a Message Extension that allows you to perform a quick s
- [Node.js](https://nodejs.org/), supported versions: 16, 18
- An [Azure subscription](https://azure.microsoft.com/en-us/free/)
- [Set up your dev environment for extending Teams apps across Microsoft 365](https://aka.ms/teamsfx-m365-apps-prerequisites)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome
> Here are the instructions to run the sample in **Visual Studio Code**. You can also try to run the app using TeamsFx CLI tool, refer to [Try the Sample with TeamsFx CLI](cli.md)
> Here are the instructions to run the sample in **Visual Studio Code**. You can also try to run the app using Teams Toolkit CLI tool, refer to [Try the Sample with Teams Toolkit CLI](cli.md)
### Run the app locally
1. Clone the repo to your local workspace or directly download the source code.
Expand Down
2 changes: 1 addition & 1 deletion NPM-search-connector-M365/cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Minimal path to awesome
1. Install TeamsFx CLI using the npm package manager:
1. Install Teams Toolkit CLI using the npm package manager:
```
npm install -g @microsoft/teamsapp-cli
```
Expand Down
4 changes: 2 additions & 2 deletions NPM-search-message-extension-codespaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Search based message extensions allow you to query your service and post that in
1. Sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.
1. Click `Provision` from `LIFECYCLE` section or open the command palette and select: `Teams: Provision`.
1. Click `Deploy` or open the command palette and select: `Teams: Deploy`.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp auth login azure`.
1. Run command: `teamsapp provision --env dev`.
1. Run command: `teamsapp deploy --env dev`.

### Preview the app in Teams
- From VS Code:
1. Open the `Run and Debug Activity` Panel. Select `Launch Remote (Codespaces)` from the launch configuration drop-down.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp preview --env dev`.

## Version History
Expand Down
2 changes: 1 addition & 1 deletion README_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ the gif contains only major steps of using the app, keep the gif short.
## Prerequisite to use this sample
- NodeJS version XX
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program).
- [Teams Toolkit for VS Code](https://aka.ms/teams-toolkit) or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit for VS Code](https://aka.ms/teams-toolkit) or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome

Expand Down
4 changes: 2 additions & 2 deletions adaptive-card-notification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ Adaptive Card Notification provides an easy way to send notification in Teams. T
## Prerequisite to use this sample
- [Node.js](https://nodejs.org/), supported versions: 16, 18
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program).
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)
- An [Azure subscription](https://azure.microsoft.com/en-us/free/)

## Minimal path to awesome
>Here are the instructions to run the sample in **Visual Studio Code**. You can also try to run the app using TeamsFx CLI tool, refer to [Try the Sample with TeamsFx CLI](cli.md)
>Here are the instructions to run the sample in **Visual Studio Code**. You can also try to run the app using Teams Toolkit CLI tool, refer to [Try the Sample with Teams Toolkit CLI](cli.md)
### Run the app locally
1. Clone the repo to your local workspace or directly download the source code.
Expand Down
4 changes: 2 additions & 2 deletions adaptive-card-notification/cli.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Try sample with TeamsFx CLI
## Try sample with Teams Toolkit CLI

1. Install [Node.js](https://nodejs.org/en/download/) (Recommend LTS 16.x)
1. To install the TeamsFx CLI, use the npm package manager:
1. To install the Teams Toolkit CLI, use the npm package manager:
```
npm install -g @microsoft/teamsapp-cli
```
Expand Down
8 changes: 4 additions & 4 deletions bot-sso-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This is a sample chatbot application running in Docker container. It demonstrate

- [Docker Engine](https://docs.docker.com/engine/install/)
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program).
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teamsfx-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)
- [Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) for Azure Container Apps deployment

## Containerization of Teams App
Expand All @@ -55,7 +55,7 @@ This sample demonstrate how to containerize a Teams App and integrate the Docker

- From VS Code:
1. hit `F5` to start debugging. Alternatively open the `Run and Debug Activity` Panel and select `Debug (Edge)` or `Debug (Chrome)`.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Install [dev tunnel cli](https://aka.ms/teamsfx-install-dev-tunnel).
1. Login with your M365 Account using the command `devtunnel user login` .
1. Start your local tunnel service by running the command `devtunnel host -p 3978 --protocol http --allow-anonymous` .
Expand All @@ -76,7 +76,7 @@ This sample demonstrate how to containerize a Teams App and integrate the Docker
1. Click `Provision` from `LIFECYCLE` section or open the command palette and select: `Teams: Provision`.
1. Login Azure CLI with commands: `az login` and `az account set -s <subscription-id>`.
1. Click `Deploy` or open the command palette and select: `Teams: Deploy`.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp account login azure` .
1. Run command: `teamsapp provision --env dev` .
1. Run command: `az login` .
Expand All @@ -86,7 +86,7 @@ This sample demonstrate how to containerize a Teams App and integrate the Docker

- From VS Code:
1. Open the `Run and Debug Activity` Panel. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp preview --env dev`.

## Further reading
Expand Down
4 changes: 2 additions & 2 deletions bot-sso-docker/cli.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Try sample with TeamsFx CLI
## Try sample with Teams Toolkit CLI

1. Install [Node.js](https://nodejs.org/download/)
1. To install the TeamsFx CLI, use the npm package manager:
1. To install the Teams Toolkit CLI, use the npm package manager:
```
npm install -g @microsoft/teamsapp-cli
```
Expand Down
8 changes: 4 additions & 4 deletions bot-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil
## Prerequisite to use this sample
- [Node.js](https://nodejs.org/), supported versions: 16, 18
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program).
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

> Note: If you are using node 20, you can add following snippet in package.json to remove the warning of incompatibility. (Related discussion: https://github.com/microsoft/botbuilder-js/issues/4550)
```
Expand All @@ -40,7 +40,7 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil
### Run the app locally
- From VS Code:
1. hit `F5` to start debugging. Alternatively open the `Run and Debug Activity` Panel and select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Install [dev tunnel cli](https://aka.ms/teamsfx-install-dev-tunnel).
1. Login with your M365 Account using the command `devtunnel user login`.
1. Start your local tunnel service by running the command `devtunnel host -p 3978 --protocol http --allow-anonymous`.
Expand All @@ -58,15 +58,15 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil
1. Sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.
1. Click `Provision` from `LIFECYCLE` section or open the command palette and select: `Teams: Provision`.
1. Click `Deploy` or open the command palette and select: `Teams: Deploy`.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp auth login azure`.
1. Run command: `teamsapp provision --env dev`.
1. Run command: `teamsapp deploy --env dev`.

### Preview the app in Teams
- From VS Code:
1. Open the `Run and Debug Activity` Panel. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp preview --env dev`.

## Version History
Expand Down
8 changes: 4 additions & 4 deletions command-bot-with-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This is a simple command bot that implements single sign-on feature to retrieve

- [Node.js](https://nodejs.org/) version 16, 18
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program).
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome

Expand All @@ -35,7 +35,7 @@ This is a simple command bot that implements single sign-on feature to retrieve
1. Open Debug View (`Ctrl+Shift+D`) and select "Debug in Teams (Edge)" or "Debug in Teams (Chrome)" in dropdown list.
1. Press "F5" to open a browser window and then select your package to view contact exporter sample app.

- From TeamsFx CLI
- From Teams Toolkit CLI
1. Install [dev tunnel cli](https://aka.ms/teamsfx-install-dev-tunnel).
1. Login with your M365 Account using the command `devtunnel user login`.
1. Start your local tunnel service by running the command `devtunnel host -p 3978 --protocol http --allow-anonymous`.
Expand All @@ -58,7 +58,7 @@ This is a simple command bot that implements single sign-on feature to retrieve
1. Click `Provision` from `LIFECYCLE` section or open the command palette and select: `Teams: Provision`.
1. Click `Deploy` or open the command palette and select: `Teams: Deploy`.

- From TeamsFx CLI
- From Teams Toolkit CLI
1. Run command: `teamsapp auth login azure`.
1. Run command: `teamsapp provision --env dev`.
1. Run command: `teamsapp deploy --env dev`.
Expand All @@ -67,7 +67,7 @@ This is a simple command bot that implements single sign-on feature to retrieve

- From VSCode:
1. Once deployment is completed, you can preview the APP running in Azure. In Visual Studio Code, open `Run and Debug` and select `Launch Remote (Edge)` or `Launch Remote (Chrome)` in the dropdown list and Press `F5` or green arrow button to open a browser.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp preview --env dev`.

## Version History
Expand Down
4 changes: 2 additions & 2 deletions developer-assist-dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ Developer Assist Dashboard shows you how to build a tab with Azure DevOps work i

- [Node.js](https://nodejs.org/), supported versions: 16, 18
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [M365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome

> Here are the instructions to run the sample in **Visual Studio Code**. You can also try to run the app using TeamsFx CLI tool, refer to [Try the Sample with TeamsFx CLI](cli.md)
> Here are the instructions to run the sample in **Visual Studio Code**. You can also try to run the app using Teams Toolkit CLI tool, refer to [Try the Sample with Teams Toolkit CLI](cli.md)
### Run the app locally

Expand Down
4 changes: 2 additions & 2 deletions developer-assist-dashboard/cli.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Try sample with TeamsFx CLI
## Try sample with Teams Toolkit CLI

1. Install [Node.js](https://nodejs.org/en/download/) (Recommend LTS 16.x)
1. To install the TeamsFx CLI, use the npm package manager:
1. To install the Teams Toolkit CLI, use the npm package manager:
```
npm install -g @microsoft/teamsapp-cli
```
Expand Down
2 changes: 1 addition & 1 deletion graph-connector-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This sample app showcases how to build custom Graph Connector with Azure Functio
- [Node.js](https://nodejs.org/), supported versions: 16, 18
- An [Azure subscription](https://azure.microsoft.com/en-us/free/)
- A Microsoft 365 account. If you do not have Microsoft 365 account, apply one from [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome

Expand Down
2 changes: 1 addition & 1 deletion graph-connector-bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This sample app showcases how to build a Teams command bot that queries custom d
- [Node.js](https://nodejs.org/), supported versions: 16, 18
- An [Azure subscription](https://azure.microsoft.com/en-us/free/)
- An Microsoft 365 account with admin permission. If you do not have M365 account, apply one from [M365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome

Expand Down
8 changes: 4 additions & 4 deletions graph-toolkit-contact-exporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Graph Toolkit Contact Exporter sample APP provides an easy way to export your te

- [Node.js](https://nodejs.org/) version 16, 18
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program).
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome

Expand All @@ -41,7 +41,7 @@ Graph Toolkit Contact Exporter sample APP provides an easy way to export your te
1. Open Debug View (`Ctrl+Shift+D`) and select "Debug in Teams (Edge)" or "Debug in Teams (Chrome)" in dropdown list.
1. Press "F5" to open a browser window and then select your package to view contact exporter sample app.

- From TeamsFx CLI
- From Teams Toolkit CLI
1. Run command: `teamsapp provision --env local` .
1. Run command: `teamsapp deploy --env local` .
1. Run command: `teamsapp preview --env local` .
Expand All @@ -56,7 +56,7 @@ Graph Toolkit Contact Exporter sample APP provides an easy way to export your te
1. Click `Provision` from `LIFECYCLE` section or open the command palette and select: `Teams: Provision`.
1. Click `Deploy` or open the command palette and select: `Teams: Deploy`.

- From TeamsFx CLI
- From Teams Toolkit CLI
1. Run command: `teamsapp auth login azure`.
1. Run command: `teamsapp provision --env dev`.
1. Run command: `teamsapp deploy --env dev`.
Expand All @@ -65,7 +65,7 @@ Graph Toolkit Contact Exporter sample APP provides an easy way to export your te

- From VSCode:
1. Once deployment is completed, you can preview the APP running in Azure. In Visual Studio Code, open `Run and Debug` and select `Launch Remote (Edge)` or `Launch Remote (Chrome)` in the dropdown list and Press `F5` or green arrow button to open a browser.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp preview --env dev`.

### Run the app locally with proxy
Expand Down
8 changes: 4 additions & 4 deletions graph-toolkit-one-productivity-hub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ One Productivity Hub sample shows you how to build a tab for viewing your calend

- [Node.js](https://nodejs.org/) version 16, 18
- A Microsoft 365 tenant in which you have permission to upload Teams apps. You can get a free Microsoft 365 developer tenant by joining the [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program).
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [TeamsFx CLI](https://aka.ms/teams-toolkit-cli)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)

## Minimal path to awesome

Expand All @@ -41,7 +41,7 @@ One Productivity Hub sample shows you how to build a tab for viewing your calend
1. Open Debug View (`Ctrl+Shift+D`) and select "Debug in Teams (Edge)" or "Debug in Teams (Chrome)" in dropdown list.
1. Press "F5" to open a browser window and then select your package to view contact exporter sample app.

- From TeamsFx CLI
- From Teams Toolkit CLI
1. Run command: `teamsapp provision --env local` .
1. Run command: `teamsapp deploy --env local` .
1. Run command: `teamsapp preview --env local` .
Expand All @@ -56,7 +56,7 @@ One Productivity Hub sample shows you how to build a tab for viewing your calend
1. Click `Provision` from `LIFECYCLE` section or open the command palette and select: `Teams: Provision`.
1. Click `Deploy` or open the command palette and select: `Teams: Deploy`.

- From TeamsFx CLI
- From Teams Toolkit CLI
1. Run command: `teamsapp auth login azure`.
1. Run command: `teamsapp provision --env dev`.
1. Run command: `teamsapp deploy --env dev`.
Expand All @@ -65,7 +65,7 @@ One Productivity Hub sample shows you how to build a tab for viewing your calend

- From VSCode:
1. Once deployment is completed, you can preview the APP running in Azure. In Visual Studio Code, open `Run and Debug` and select `Launch Remote (Edge)` or `Launch Remote (Chrome)` in the dropdown list and Press `F5` or green arrow button to open a browser.
- From TeamsFx CLI:
- From Teams Toolkit CLI:
1. Run command: `teamsapp preview --env dev`.

## Advanced usage of this sample
Expand Down
Loading

0 comments on commit bfe0deb

Please sign in to comment.