Skip to content
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

Fix CLI instructions #1122

Merged
merged 1 commit into from
May 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/cli/user-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ TeamsFx CLI is a text-based command line interface that accelerates Teams applic
# Commands
| `teamsFx` Commands | Descriptions |
|:---------------- |:-------------|
| `teamsfx new` | Manage cloud service accounts. The supported cloud services are 'Azure' and 'M365'. |
| `teamsfx account` | Create a new Teams application. |
| `teamsfx new` | Create a new Teams application. |
| `teamsfx account` | Manage cloud service accounts. The supported cloud services are 'Azure' and 'M365'. |
| `teamsfx capability`| Add new capabilities to the current application. |
| `teamsfx resource` | Manage the resources in the current application. |
| `teamsfx provision` | Provision the cloud resources in the current application. |
Expand Down
8 changes: 3 additions & 5 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# TeamsFx Command Line Tool

## TeamsFx CLI

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

## Getting Started

Let's start by installing teamsfx-cli and run cli command:
Let's start by installing `teamsfx-cli` from NPM and run `teamsfx -h` to check all available commands:

```powershell
$ npm install -g @microsoft/teamsfx-cli
$ teamsfx -v
$ teamsfx -h
```

Please refer to [TeamsFx CLI User Manual](/docs/cli/user-manual.md).
Please refer to [TeamsFx CLI User Manual](/docs/cli/user-manual.md) for in-depth instructions.

## Extensibility Model

Expand Down
2 changes: 1 addition & 1 deletion templates/bot-msgext/js/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This is a simple hello world application with both Bot and Message extension cap

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the messaging extension capability from the prompts.
> Note: You have the option to reuse an existing bot by entering the credential manually. But make sure that bot is not associated with any AAD apps.

Expand Down
2 changes: 1 addition & 1 deletion templates/bot-msgext/ts/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This is a simple hello world application with both Bot and Message extension cap

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the messaging extension capability from the prompts.
> Note: You have the option to reuse an existing bot by entering the credential manually. But make sure that bot is not associated with any AAD apps.

Expand Down
2 changes: 1 addition & 1 deletion templates/bot/js/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the bot capabilities from the prompts.
> Note: You have the option to reuse an existing bot by entering the credential manually. But make sure that bot is not associated with any AAD apps.

Expand Down
2 changes: 1 addition & 1 deletion templates/bot/ts/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the bot capabilities from the prompts.
> Note: You have the option to reuse an existing bot by entering the credential manually. But make sure that bot is not associated with any AAD apps.

Expand Down
2 changes: 1 addition & 1 deletion templates/function-base/js/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Deploy your project to Azure by following these steps:

| From Visual Studio Code | Using TeamsFx CLI |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command: `teamsfx deploy`. </li></ul> |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command `teamsfx deploy`. </li></ul> |

> Note: Provisioning and deployment may incur charges to your Azure Subscription.

Expand Down
2 changes: 1 addition & 1 deletion templates/function-base/ts/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Deploy your project to Azure by following these steps:

| From Visual Studio Code | Using TeamsFx CLI |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command: `teamsfx deploy`. </li></ul> |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command `teamsfx deploy`. </li></ul> |

> Note: Provisioning and deployment may incur charges to your Azure Subscription.

Expand Down
2 changes: 1 addition & 1 deletion templates/msgext/js/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A Messaging Extension allows users to interact with your web service while compo

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the messaging extension capability from the prompts.
> Note: You have the option to reuse an existing bot by entering the credential manually. But make sure that bot is not associated with any AAD apps.

Expand Down
2 changes: 1 addition & 1 deletion templates/msgext/ts/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A Messaging Extension allows users to interact with your web service while compo

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the messaging extension capability from the prompts.
> Note: You have the option to reuse an existing bot by entering the credential manually. But make sure that bot is not associated with any AAD apps.

Expand Down
2 changes: 1 addition & 1 deletion templates/tab/js/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Microsoft Teams supports the ability to run web-based UI inside "custom tabs" th

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the "Custom tab" capability from the prompts.

## Debug
Expand Down
2 changes: 1 addition & 1 deletion templates/tab/ts/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Microsoft Teams supports the ability to run web-based UI inside "custom tabs" th

## Create an application

- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g teamsfx`) run command `teamsfx new`.
- From Visual Studio Code, open command palette and select `Teams - Start a new project`. Or from the CLI, (after `npm install -g @microsoft/teamsfx-cli`) run command `teamsfx new`.
- Choose the "Custom tab" capability from the prompts.

## Debug
Expand Down