Skip to content

Commit 255ff3f

Browse files
authored
doc: Add info about plugin uninstallation (#76)
1 parent d7451ae commit 255ff3f

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,19 @@ You can build the binary plugin by running `make build`. You'll need to have Go
88

99
## Using the plugin from the CLI
1010

11-
You can also use the plugin with your changes from the CLI by running: `make local` and following the instructions displayed.
11+
You can also use the plugin with your changes from the CLI by running: `make local` and following the instructions displayed.
12+
13+
**Important:** Before using the local version, uninstall any previously installed version of the plugin to avoid "multiple plugins" errors:
14+
```bash
15+
atlas plugin uninstall atlas-cli-plugin-terraform
16+
```
17+
18+
The `make local` command will:
19+
1. Clean and build the plugin binary
20+
2. Generate a local manifest file
21+
3. Set up the plugin in a local directory
22+
4. Display instructions to export the `ATLAS_CLI_EXTRA_PLUGIN_DIRECTORY` environment variable
23+
5. Show you how to verify the plugin is available with `atlas plugin list`
1224

1325
## Third Party Dependencies and Vulnerability Scanning
1426

@@ -28,4 +40,4 @@ All releases are recorded using a MongoDB-internal application called Papertrail
2840
This is done automatically as part of the release.
2941

3042
### Release Artifact Signing
31-
All releases are signed automatically as part of the release process.
43+
All releases are signed automatically as part of the release process.

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ If you want to see the list of installed plugins or check if this plugin is inst
2323
atlas plugin list
2424
```
2525

26+
If you want to uninstall the plugin, run:
27+
```bash
28+
atlas plugin uninstall atlas-cli-plugin-terraform
29+
```
30+
2631
## Available Commands
2732

2833
The plugin provides the following commands to help with your Terraform configurations:
@@ -61,4 +66,4 @@ See our [CONTRIBUTING.md](CONTRIBUTING.md) guide.
6166

6267
## License
6368

64-
MongoDB Atlas CLI is released under the Apache 2.0 license. See [LICENSE.md](LICENSE.md)
69+
MongoDB Atlas CLI is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt)

0 commit comments

Comments
 (0)