Skip to content

Conversation

rose-m
Copy link
Contributor

@rose-m rose-m commented Mar 5, 2021

New help:

  $ mongosh [options] [db address]

  Options:

    -h, --help                                 Show this usage information
        --host [arg]                           Server to connect to
        --port [arg]                           Port to connect to
        --version                              Show version information
        --nodb                                 Don't connect to mongod on startup - no 'db address' [arg] expected
        --retryWrites                          Automatically retry write operations upon transient network errors

  Authentication Options:

    -u, --username [arg]                       Username for authentication
    -p, --password [arg]                       Password for authentication
        --authenticationDatabase [arg]         User source (defaults to dbname)
        --authenticationMechanism [arg]        Authentication mechanism
        --awsIamSessionToken [arg]             AWS IAM Temporary Session Token ID

  TLS Options:

        --tls                                  Use TLS for all connections
        --tlsCertificateKeyFile [arg]          PEM certificate/key file for TLS
        --tlsCertificateKeyFilePassword [arg]  Password for key in PEM file for TLS
        --tlsCAFile [arg]                      Certificate Authority file for TLS
        --tlsAllowInvalidHostnames             Allow connections to servers with non-matching hostnames
        --tlsAllowInvalidCertificates          Allow connections to servers with invalid certificates
        --tlsCertificateSelector [arg]         TLS Certificate in system store
        --tlsDisabledProtocols [arg]           Comma separated list of TLS protocols to disable [TLS1_0,TLS1_1,TLS1_2]

  FLE Options:

        --awsAccessKeyId [arg]                 AWS Access Key for FLE Amazon KMS
        --awsSecretAccessKey [arg]             AWS Secret Key for FLE Amazon KMS
        --awsSessionToken [arg]                Optional AWS Session Token ID
        --keyVaultNamespace [arg]              database.collection to store encrypted FLE parameters
        --kmsURL [arg]                         Test parameter to override the URL of the KMS endpoint

  DB Address Examples:

        foo                                    Foo database on local machine
        192.168.0.5/foo                        Foo database on 192.168.0.5 machine
        192.168.0.5:9999/foo                   Foo database on 192.168.0.5 machine on port 9999
        mongodb://192.168.0.5:9999/foo         Connection string URI can also be used

  Examples:

        Start mongosh using 'ships' database on specified connection string:
        $ mongosh mongodb://192.168.0.5:9999/ships

  For more information on usage: https://docs.mongodb.com/mongodb-shell.

@rose-m rose-m added the wip Work in Progress label Mar 5, 2021
Comment on lines +52 to 53
fileNames: 'File Names:',
filenameDescription: 'A list of files to run. Files must end in .js and will exit after unless --shell is specified.',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those are not used anywhere anymore, right?

@gribnoysup
Copy link
Collaborator

Oh, sorry, didn't notice the wip label

@rose-m
Copy link
Contributor Author

rose-m commented Mar 5, 2021

No worries :D Yeah there are some in the translations that are not used right now but will be once we add them back. I'll leave them in there for now. The thing I noticed (hence the WIP) is that some tls options are missing.

@gribnoysup
Copy link
Collaborator

Ah, right, should've read them more carefully, makes sense!

@rose-m rose-m removed the wip Work in Progress label Mar 5, 2021
@rose-m rose-m merged commit 0928ec3 into master Mar 5, 2021
@rose-m rose-m deleted the MONGOSH-571-cleanup-arg-documentation branch March 5, 2021 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants