Uploaded image for project: 'Compass '
  1. Compass
  2. COMPASS-6074

Implement connection import via CLI

    • Needed
    • Hide

      Compass adds support for importing and exporting favorite connections from the command line.

      In the following examples, "mongodb-compass" stands for the Compass executable, or the path to it, respectively. For example, this could be MongoDBCompass.exe on Windows, mongodb-compass on Linux, and MongoDB Compass on macOS, preceded by the installation path.

      Exporting connections can be performed via

      mongodb-compass --export-connections=<filename> --passphrase=<passphrase>
      

      Where Compass will export all favorite connections to filename. If --passphrase is provided, it will encrypt secrets in the resulting file using that passphrase. If it is not provided, connection secrets will be included in unencrypted format. Importing connections happens similarly:

      mongodb-compass --import-connections=<filename> --passphrase=<passphrase>
      

      It is worth noting that in the near future, Compass will introduce related features:

      • COMPASS-6066 will include a new flag that can also be passed on the command line together with the other export flags, which, amongst other things, will make Compass omit secrets when exporting
      • COMPASS-6075 and COMPASS-6076, which will add the same functionality to the Compass UI itself.
      Show
      Compass adds support for importing and exporting favorite connections from the command line. In the following examples, "mongodb-compass" stands for the Compass executable, or the path to it, respectively. For example, this could be MongoDBCompass.exe on Windows, mongodb-compass on Linux, and MongoDB Compass on macOS, preceded by the installation path. Exporting connections can be performed via mongodb-compass --export-connections=<filename> --passphrase=<passphrase> Where Compass will export all favorite connections to filename . If --passphrase is provided, it will encrypt secrets in the resulting file using that passphrase. If it is not provided, connection secrets will be included in unencrypted format. Importing connections happens similarly: mongodb-compass -- import -connections=<filename> --passphrase=<passphrase> It is worth noting that in the near future, Compass will introduce related features: COMPASS-6066 will include a new flag that can also be passed on the command line together with the other export flags, which, amongst other things, will make Compass omit secrets when exporting COMPASS-6075 and COMPASS-6076 , which will add the same functionality to the Compass UI itself.

      This includes adding telemetry and e2e tests.

            Assignee:
            anna.henningsen@mongodb.com Anna Henningsen
            Reporter:
            anna.henningsen@mongodb.com Anna Henningsen
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: