Extending the MongoDB Atlas CLI With Custom Plugins

1
name: atlas-cli-plugin-example
2
description: this is an example plugin
3
version: 2.0.1
4
github:
5
    owner: mongodb
6
    name: atlas-cli-plugin-example
7
binary: binary
8
commands: 
9
    example: 
10
        description: Root command of the atlas cli plugin example

1
atlas example-plugin do-something --flag value

1
git clone https://github.com/your-github-username/your-repository-name

1
name: blog-example
2
description: this is an example plugin
3
version: $VERSION
4
github:
5
  owner: $GITHUB_REPOSITORY_OWNER
6
  name: $GITHUB_REPOSITORY_NAME
7
binary: binary
8
commands:
9
  blog-example:
10
    description: Root command of the atlas cli plugin example

1
func main() {
2
    exampleCmd := &cobra.Command{
3
        Use:   "blog-example",
4
        Short: "Root command of the atlas cli plugin example",
5
    }
6
    exampleCmd.AddCommand(
7
        hello.Builder(),
8
        // other commands…
9
    )
10
    // ... rest of the main function
11
}

1
package hello
2
3
import (
4
	"fmt"
5
6
	"github.com/spf13/cobra"
7
)
8
9
func Builder() *cobra.Command {
10
	return &cobra.Command{
11
		Use:   "hello",
12
		Short: "The Hello World command",
13
		Run: func(_ *cobra.Command, _ []string) {
14
			fmt.Println("Hello World, from my first AtlasCLI plugin!")
15
		},
16
	}
17
}

1
git commit -a -m "Blog post changes"
2
git push

1
git tag v1.0.0
2
git push origin v1.0.0

1
atlas plugin install your-github-username/your-repository-name

1
❯ atlas blog-example hello
2
3
Hello World, from my first AtlasCLI plugin!