diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f69021..ce4ea21 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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. \ No newline at end of file +All releases are signed automatically as part of the release process. diff --git a/README.md b/README.md index dfde07a..a61f57d 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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)