Skip to content

doc: Add info about plugin uninstallation #76

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

Merged
merged 2 commits into from
Sep 5, 2025
Merged

doc: Add info about plugin uninstallation #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7533ee1
add uninstall info
lantoli Sep 5, 2025
bad412c
fix license link
lantoli Sep 5, 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
16 changes: 14 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,19 @@ You can build the binary plugin by running `make build`. You'll need to have Go

## Using the plugin from the CLI

You can also use the plugin with your changes from the CLI by running: `make local` and following the instructions displayed.
You can also use the plugin with your changes from the CLI by running: `make local` and following the instructions displayed.

**Important:** Before using the local version, uninstall any previously installed version of the plugin to avoid "multiple plugins" errors:
```bash
atlas plugin uninstall atlas-cli-plugin-terraform
```

The `make local` command will:
1. Clean and build the plugin binary
2. Generate a local manifest file
3. Set up the plugin in a local directory
4. Display instructions to export the `ATLAS_CLI_EXTRA_PLUGIN_DIRECTORY` environment variable
5. Show you how to verify the plugin is available with `atlas plugin list`

## Third Party Dependencies and Vulnerability Scanning

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

### Release Artifact Signing
All releases are signed automatically as part of the release process.
All releases are signed automatically as part of the release process.
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ If you want to see the list of installed plugins or check if this plugin is inst
atlas plugin list
```

If you want to uninstall the plugin, run:
```bash
atlas plugin uninstall atlas-cli-plugin-terraform
```

## Available Commands

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

## License

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