TEAMS-TOOLKIT-CLI.md

Teams Toolkit CLI

Navigation

• 00.OVERVIEW
• Bot Framework Emulator
• Manual resource setup
• Teams Toolkit CLI
• Teams Toolkit extra information

Below are directions on running samples via the Teams Toolkit CLI.

1. Install the CLI and install the project if you haven't yet done so

   npm install -g @microsoft/teamsfx-cli
   #if you have not built the project yet, run:
   cd teams-ai/js
   yarn && yarn build # this only needs to be done once after clone or pull

2. Open a second shell instance and run ngrok tunneling service - point to port 3978

   ngrok http --host-header=rewrite 3978

3. Copy the ngrok URL and put the URL and domain in the /env/env.local file

   BOT_ENDPOINT=https://{ngrok-url}.ngrok.io
   BOT_DOMAIN={ngrok-url}.ngrok.io

4. In the repository directory, run the Teams Toolkit CLI commands to automate the setup needed for the app

   cd teams-ai/js/samples/00.path-to/x.sample/
   teamsfx provision --env local
   

5. Next, use the CLI to validate and create an app package

   teamsfx deploy --env local

6. Finally, use the CLI to preview the app in Teams

   teamsfx preview --env local

---

Return to other major section topics:

• CONCEPTS
• MIGRATION
• QUICKSTART
• SAMPLES
• OTHER