otty / apps

All apps/MongoDB Atlas CLI

MongoDB Atlas CLI

mongodb-atlas-cli

The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.

Runs as atlas|macOS, Linux, Windows|www.mongodb.com

Open form in Otty otty.toml

Sync rules

What travels, what stays, what never leaves

MongoDB Atlas CLI in your home directory Every rule on this page, by file

*.mongosh_path

Each machine keeps its own copy of these.

*.public_api_key*.private_api_key*.access_token*.refresh_token

Lifted into your secret store; the rest of the file syncs.

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/mongodb-atlas-cli/otty.tomlThe file this page is generated from

id = "mongodb-atlas-cli"

name = "MongoDB Atlas CLI"

homepage = "https://www.mongodb.com/docs/atlas/cli/current/"

description = "The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal."

icon = "SimpleIcons:mongodb"

# The binary is `atlas`. Note that ariga/atlas ships a binary of the same name;

# only the MongoDB tool's paths are described here.

executables = ["atlas"]

[dotfiles]

# https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings/

# gives config.toml under %AppData%/atlascli on Windows,

# /Users/{username}/Library/Application Support/atlascli on macOS and

# $XDG_CONFIG_HOME/atlascli (defaulting to $HOME/.config/atlascli) on Linux —

# one location under three names, which is [appData].

paths = ["[appData]/atlascli/config.toml"]

exclude = []

# The file is a set of named profiles; org_id, project_id, service and output

# are ordinary settings worth carrying between machines, so only the

# credential fields inside it are lifted out.

secret = []

side_effect = false

# The same page lists these four as redacted in `atlas config describe`: the

# API key pair and the tokens from a browser login.

[[dotfiles.secret_paths]]

file = "[appData]/atlascli/config.toml"

match = { key_path = ["*.public_api_key", "*.private_api_key", "*.access_token", "*.refresh_token"] }

# mongosh_path is an absolute path to the MongoDB Shell installed on this

# machine.

# Where the installer puts mongosh follows from the OS and the architecture,

# not from this particular box, so the value holds for that whole machine class.

[[dotfiles.machine_lines]]

file = "[appData]/atlascli/config.toml"

match = { key_path = ["*.mongosh_path"] }

scope = "platform"

[commands]

format = 1

label = "atlas"

description = "Manage MongoDB Atlas. Use the tabs for listing and creating clusters; other resources are left out."

quality = "ai-draft"

base = "fig:atlas"

parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/atlas.ts"

license = "MIT"

[[commands.subcommand]]

path = ["cluster", "ls"]

label = "List clusters"

description = "List the clusters in a project."

parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/atlas.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "project_id"

label = "Project ID"

type = "string"

option = ["--projectId"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "output"

label = "Output format"

type = "string"

option = ["--output", "-o"]

suggestions = [{ value = "json", label = "json" }, { value = "json-path", label = "json-path" }, { value = "go-template", label = "go-template" }, { value = "go-template-file", label = "go-template-file" }]

sources = ["fig"]

[[commands.subcommand.field]]

id = "limit"

label = "Items per page"

type = "integer"

option = ["--limit"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "page"

label = "Page number"

type = "integer"

option = ["--page"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "list"

label = "List clusters"

fields = ["project_id", "output"]

required = []

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["project_id", "output", "limit", "page"]

[[commands.subcommand]]

path = ["cluster", "create"]

label = "Create a cluster"

description = "Create one cluster in a project. A JSON file can provide the whole configuration."

parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/atlas.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "project_id"

label = "Project ID"

type = "string"

option = ["--projectId"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "provider"

label = "Cloud provider"

type = "string"

option = ["--provider"]

suggestions = [{ value = "AWS", label = "AWS" }, { value = "AZURE", label = "AZURE" }, { value = "GCP", label = "GCP" }]

sources = ["fig"]

[[commands.subcommand.field]]

id = "region"

label = "Region"

type = "string"

option = ["--region", "-r"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "tier"

label = "Tier"

type = "string"

option = ["--tier"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "type"

label = "Cluster type"

type = "string"

option = ["--type"]

suggestions = [{ value = "REPLICASET", label = "REPLICASET" }, { value = "SHARDED", label = "SHARDED" }]

sources = ["fig"]

[[commands.subcommand.field]]

id = "members"

label = "Replica set members"

type = "integer"

option = ["--members", "-m"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "shards"

label = "Shards"

type = "integer"

option = ["--shards", "-s"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "disk_size"

label = "Disk size (GB)"

type = "integer"

option = ["--diskSizeGB"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "mdb_version"

label = "MongoDB version"

type = "string"

option = ["--mdbVersion"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "backup"

label = "Enable Continuous Cloud Backup"

type = "boolean"

option = ["--backup"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "file"

label = "Configuration file"

type = "path"

option = ["--file", "-f"]

path = { kind = "file", role = "input" }

sources = ["fig"]

[[commands.subcommand.task]]

id = "create"

label = "Create a cluster"

fields = ["project_id", "provider", "region", "tier", "type"]

required = ["provider", "region", "tier"]

[[commands.subcommand.task]]

id = "from_file"

label = "Create from JSON file"

fields = ["project_id", "file"]

required = ["file"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["project_id", "provider", "region", "tier", "type", "file"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["members", "shards", "disk_size", "mdb_version", "backup"]

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/mongodb-atlas-cli. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits *.mongosh_path for you — that part is Otty’s own sync, or a template you write by hand.