Skip to content

docs: Update plugins.md testing instructions #649

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update plugins.md testing instructions #649

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2deb03
Update plugins.md testing instructions
micaswyers-work Jun 20, 2025
f6eca64
Merge branch 'main' into main
micaswyers-work Jul 1, 2025
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
15 changes: 6 additions & 9 deletions docs/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,27 +55,24 @@ MySpectacularPlugin.flags = Object.assign({'fave-dessert': flag.string({'descrip

## 4. Test your plugin with the CLI

You are probably using NPM if you develop a twilio-cli plugin, so install it if you have not already done so:

`npm install -g twilio-cli`

Follow the set-up instructions in the [twilio-cli Quickstart](https://www.twilio.com/docs/twilio-cli/quickstart). The Quickstart also includes instructions for homebrew installation.
Follow the installation and set-up instructions in the [twilio-cli Quickstart](https://www.twilio.com/docs/twilio-cli/quickstart).

For testing, "install" the plugin referencing your plugin's local development folder by linking to your plugin.

Run this command from the CLI folder. This assumes the CLI and your plugin folders are siblings of each other (perhaps in a `~/Projects` folder):

```
./bin/run plugins:link ../plugin-<my-spectacular-plugin>
twilio plugins:link ../plugin-<my-spectacular-plugin>
```


Now, you can run your plugin command from the CLI:

```
twilio my-new-topic:my-new-command --help
```

To verify which plugins you have installed and linked, run `twilio plugins`. Any linked plugins will display "link" next to them.

To unlink your plugin, run `twilio plugins:unlink <plugin-name>`. This uninstalls the plugin, so you will need to install it again if you want to use the public, non-development version.

## 5. Publish your plugin to NPM

Once you have your plugin working, publish it to npmjs.org as a JavaScript package using `npm publish`. The `twilio plugins:install <npm package name>` command will download your package from NPM.
Expand Down