Docs Menu

Snippet Commands

On this page

  • Commands
Warning

This feature is experimental. MongoDB does not provide support for Snippets. This feature may be changed or removed at any time without prior notice.

Bugs are not expected, however should you encounter one, please open an issue in the GitHub repository for this project.

This document provides an overview of the commands that are available to work with snippets.

Command
Description
help

Show the help text or information about a specific snippet. See an example.

snippet help
snippet help <snippet-name>
info

Show information about configured snippet repositories. See an example.

snippet info
install

Install a new snippet. See an example.

snippet install <snippet-name>
ls

List name and version of installed snippets. See an example

snippet ls
load-all

Load all installed snippets into the current environment.

snippet load-all
outdated

List snippets that have updated registry versions.

snippet outdated
refresh

Clear and refresh the snippet metadata cache. See an example.

snippet refresh
search

List available snippets, their version, and a brief description. See an example.

snippet search
uninstall

Remove an installed snippet. See an example.

snippet uninstall <snippet-name>
update

Get the latest versions of installed snippets

snippet update

On this page

Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.