Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.
Merged
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
7 changes: 4 additions & 3 deletions specs/ContributionGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
## Steps to create a new plugin
1. Clone the repo by running 'git clone https://github.com/microsoft/botframework-cli.git'
2. Inside the project folder run 'npm run build'
3. If you want to create a new plugin, inside the packages folder run 'npx oclif plugin <plugin-name>'
4. Add @microsoft/bf-cli-command as a dependency
3. If you want to create a new plugin, inside the packages folder(https://github.com/microsoft/botframework-cli/tree/master/packages) run 'npx oclif plugin <plugin-name>'
4. Go to the folder created by the previous command and add @microsoft/bf-cli-command as a dependency in your package.json file
5. At the root level(https://github.com/microsoft/botframework-cli) run npm run build to bootstrap the packages

## Steps to create a new command
1. To add a command, inside the plugin folder run 'npx oclif command <command-name>'. If you want to add a subcommand just name it colon separated as <command-name:subcommand-name>
2. Replace the import 'import {Command, flags} from '@oclif/command' line inside the newly created command with 'import {Command, flags} from '@microsoft/bf-cli-command'
3. Add the type to the flags property like this: static flags: flags.Input<any> = {}
4. Implement the run method
4. Implement the run method