Docs Menu
Docs Home
/ /
Atlas CLI
/

接続設定を保存する

項目一覧

  • 構成ファイルを見つけます
  • プロファイルの作成
  • プロファイルの更新
  • プロファイル付きでコマンドを実行

頻繁に使用する接続設定をプロファイルとして保存できます。 プロファイルには、プロジェクト ID、組織 ID、オプションで、今後の Atlas CLI セッションで使用する APIキーが保存されます。 時間を節約するには、各コマンドで --projectId--orgIdフラグを使用する代わりにプロファイルを指定します。 Atlas CLI は、 config.tomlと呼ばれる構成ファイルにプロファイルを保存します。

注意

環境変数に保存されている設定は、プロファイルに保存されている設定よりも優先されます。 --projectId--orgIdフラグで指定されたプロジェクトまたは組織は、プロファイルと環境変数の両方よりも優先されます。

Atlas CLI は、オペレーティング システムに応じて次の場所に構成ファイルを保存します。

%AppData/atlascli
/Users/{username}/Library/Application Support/atlascli
$XDG_CONFIG_HOME/atlascli

デフォルトでは、Atlas CLI は構成ファイルを$XDG_CONFIG_HOME環境変数で定義されたパスに保存します。 $XDG_CONFIG_HOME変数で定義されているパスを希望の場所に変更できます。 変数の変更の詳細については、「$XDG_CONFIG_HOME XDG ベース ディレクトリの仕様 」を参照してください。

$XDG_CONFIG_HOMEが設定されていない場合、Atlas CLI は次を使用します。

$HOME/.config/atlascli

Atlas CLI は、 コマンドを実行したユーザーに、 ファイルへの読み取りアクセス権および書込みアクセス権を付与します。

atlas auth loginまたはatlas config initコマンドを初めて実行すると、Atlas CLI はconfig.tomlファイルとデフォルトのプロファイルを自動的に作成します。 プロファイル、環境変数、または--projectId --orgIdフラグと フラグを指定せずに コマンドを実行すると、Atlas CLI はコマンドにデフォルトのプロファイルを使用します。

ユースケースに基づいて接続方法を選択します。

コマンド
認証方法
ユースケース
atlas auth login
Atlas のログイン認証情報と認証トークン
非プログラムの使用に最適
atlas config init
APIキー
プログラムによる使用に最適

詳細については、「接続方法の選択 」を参照してください。

  • Atlas CLI をインストールします。

  • ホストの IP アドレスをIP アクセス リストに追加します。

  • 接続方法としてatlas config initを選択した場合は、 API キーを構成する必要があります。

  • Atlas CLI インストールがファイアウォールの背後にあり、 プロキシURLを使用する場合は、 HTTP_PROXYまたはHTTPS_PROXY環境変数を設定します。

    重要

    Atlas CLI は、 httphttpssocks5スキームをサポートしています。 プロキシ サービスのアクセス リストで、メイン ターゲット URL としてcloud.mongodb.com/を指定する必要があります。 プロキシ構成で認証が有効になっている場合は、ユーザー名とパスワードも指定する必要があります。

    詳細については、「 プロキシ サーバー 」を参照してください。

ユースケースを選択し、手順に従ってプロファイルを作成します。

デフォルトのプロファイルまたは名前付きプロファイルを選択します。

デフォルトのプロファイルを作成します。

  • プロファイル、環境変数、または--projectId --orgIdフラグと フラグを指定せずに、 コマンドを実行します。

  • --profile defaultフラグを使用します。

--profile <profileName>フラグを使用するには、 という名前のプロファイルを作成します。

デフォルトのプロファイルを作成するには、次の手順に従います。 デフォルト プロファイルがすでに存在する場合、これらのコマンドはデフォルト プロファイルの値をアップデートします。

1

ターミナルでatlas auth loginコマンドを実行します。

atlas auth login

コマンドはブラウザ ウィンドウを開き、1 回限りのアクティベーション コードを返します。 このコードは 10 分後に期限切れになります。

2

まだサインインしていない場合は、ブラウザで Atlas アカウントにサインインします。

3

アクティベーション コードをブラウザに貼り付け、[ Confirm Authorizationをクリックします。

4

ターミナルに戻ります。 正常に接続すると、というメッセージが表示されます。

Successfully logged in as {Your Email Address}.

5

Down ArrowUp Arrowキーを押して目的の組織を強調表示し、 Enterを押します。

? Choose a default organization: [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)

注意

500 を超える組織にアクセスできる場合は、矢印を使用して組織を選択する前に、組織 ID または組織名を入力して結果をフィルタリングする必要があります。

6

Down ArrowキーとUp Arrowキーを押して目的のプロジェクトをハイライトし、 Enterを押します。

? Choose a default project: [Use arrows to move, type to filter]
Project1 (5e5ebffd0c04a97009061234)
Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
Project4 (5c815cc7014b768fb67e3434)
7

Down ArrowキーとUp Arrowキーを押して目的の出力形式をハイライトし、 Enterを押します。

? Default Output Format: [Use arrows to move, type to filter]
> plaintext
json
オプション
説明
plaintext
次のすべてのフィールドを含む、人間が判読可能な出力:
Atlas CLI は を返します。
json
MongoDB CLI が返すすべてのフィールドを含む JSON 出力。
8

Atlas CLI は指定されたmongoshパスを使用して配置にアクセスできます。 デフォルト値は/usr/local/bin/mongoshです。 デフォルトを受け入れるにはEnterを押し、またはシステム上のmongoshへのパスを指定してEnterを押します。

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
9

プロファイルを確認するには、構成ファイルを表示するか、 atlas config describeコマンドを実行します。 デフォルト プロファイルの場合、 <profileName>defaultです。

atlas config describe <profileName>

このコマンドは、次の設定を返します。 Atlas CLI は、セキュリティのためにアクセス トークンとリフレッシュ トークンの値を編集します。

SETTING VALUE
"access_token": "redacted",
"mongosh_path": "/usr/local/bin/mongosh",
"org_id": "60c9877baf349d6fc4fd9744",
"output": "json",
"project_id": "60c94857241ae99848af45ad",
"refresh_token": "redacted",
"service": "cloud"

カスタム名のプロファイルを作成するには、次の手順に従います。

1

profile <profileName>フラグを指定して、ターミナルでatlas auth loginコマンドを実行します。 <profileName>は、新しいプロファイルに希望する名前になります。

atlas auth login --profile myProfile

コマンドはブラウザ ウィンドウを開き、1 回限りのアクティベーション コードを返します。 このコードは 10 分後に期限切れになります。

2

まだサインインしていない場合は、ブラウザで Atlas アカウントにサインインします。

3

アクティベーション コードをブラウザに貼り付け、[ Confirm Authorization ] をクリックします。

4

ターミナルに戻ります。 正常に接続すると、というメッセージが表示されます。

Successfully logged in as {Your Email Address}.

5

Down ArrowUp Arrowキーを押して目的の組織を強調表示し、 Enterを押します。

? Choose a default organization: [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)

注意

500 を超える組織にアクセスできる場合は、矢印を使用して組織を選択する前に、組織 ID または組織名を入力して結果をフィルタリングする必要があります。

6

Down ArrowキーとUp Arrowキーを押して目的のプロジェクトをハイライトし、 Enterを押します。

? Choose a default project: [Use arrows to move, type to filter]
Project1 (5e5ebffd0c04a97009061234)
Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
Project4 (5c815cc7014b768fb67e3434)
7

Down ArrowキーとUp Arrowキーを押して目的の出力形式をハイライトし、 Enterを押します。

? Default Output Format: [Use arrows to move, type to filter]
> plaintext
json
オプション
説明
plaintext
次のすべてのフィールドを含む、人間が判読可能な出力:
Atlas CLI は を返します。
json
MongoDB CLI が返すすべてのフィールドを含む JSON 出力。
8

Atlas CLI は指定されたmongoshパスを使用して配置にアクセスできます。 デフォルト値は/usr/local/bin/mongoshです。 デフォルトを受け入れるにはEnterを押し、またはシステム上のmongoshへのパスを指定してEnterを押します。

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
9

プロファイルを確認するには、構成ファイルを表示するか、 atlas config describeコマンドを実行します。 デフォルト プロファイルの場合、 <profileName>defaultです。

atlas config describe <profileName>

このコマンドは、次の設定を返します。 Atlas CLI は、セキュリティのためにアクセス トークンとリフレッシュ トークンの値を編集します。

SETTING VALUE
"access_token": "redacted",
"mongosh_path": "/usr/local/bin/mongosh",
"org_id": "60c9877baf349d6fc4fd9744",
"output": "json",
"project_id": "60c94857241ae99848af45ad",
"refresh_token": "redacted",
"service": "cloud"

デフォルトのプロファイルまたは名前付きプロファイルを選択します。

デフォルトのプロファイルを作成します。

  • プロファイル、環境変数、または--projectId --orgIdフラグと フラグを指定せずに、 コマンドを実行します。

  • --profile defaultフラグを使用します。

--profile <profileName>フラグを使用するには、 という名前のプロファイルを作成します。

デフォルトのプロファイルを作成するには、次の手順に従います。 デフォルト プロファイルがすでに存在する場合、これらのコマンドはデフォルト プロファイルの値をアップデートします。

1

ターミナルでatlas config initコマンドを実行します。

atlas config init
2

公開鍵と秘密鍵の入力を求められたら、入力します。

3

Down ArrowUp Arrowキーを押して目的の組織を強調表示し、 Enterを押します。

? Choose a default organization: [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
4

Down ArrowキーとUp Arrowキーを押して目的のプロジェクトをハイライトし、 Enterを押します。

? Choose a default project: [Use arrows to move, type to filter]
Project1 (5e5ebffd0c04a97009061234)
Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
Project4 (5c815cc7014b768fb67e3434)
5

Down ArrowキーとUp Arrowキーを押して目的の出力形式をハイライトし、 Enterを押します。

? Default Output Format: [Use arrows to move, type to filter]
> plaintext
json
オプション
説明
plaintext
Atlas CLI が返すすべてのフィールドを含む、人間が判読可能な出力。
json
MongoDB CLI が返すすべてのフィールドを含む JSON 出力。
6

Atlas CLI は指定されたmongoshパスを使用して配置にアクセスできます。 デフォルト値は/usr/local/bin/mongoshです。 デフォルトを受け入れるにはEnterを押し、またはシステム上のmongoshへのパスを指定してEnterを押します。

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
7

プロファイルを確認するには、構成ファイルを表示するか、 atlas config describeコマンドを実行します。 デフォルト プロファイルの場合、 <profileName>defaultです。

atlas config describe <profileName>

このコマンドは、次の設定を返します。 Atlas CLI は、セキュリティのためにAPIキーの値を編集します。

SETTING VALUE
"mongosh_path": "/usr/local/bin/mongosh",
"org_id": "60c9877baf349d6fc4fd9744",
"output": "json",
"private_api_key": "redacted",
"project_id": "60c94857241ae99848af45ad",
"public_api_key": "redacted",
"service": "cloud"

カスタム名のプロファイルを作成するには、次の手順に従います。

1

profile <profileName>フラグを指定して、ターミナルでatlas config initコマンドを実行します。 <profileName>は、新しいプロファイルに希望する名前になります。

atlas config init --profile myProfile
2

公開鍵と秘密鍵の入力を求められたら、入力します。

3

Down ArrowUp Arrowキーを押して目的の組織を強調表示し、 Enterを押します。

? Choose a default organization: [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)
4

Down ArrowキーとUp Arrowキーを押して目的のプロジェクトをハイライトし、 Enterを押します。

? Choose a default project: [Use arrows to move, type to filter]
Project1 (5e5ebffd0c04a97009061234)
Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
Project4 (5c815cc7014b768fb67e3434)
5

Down ArrowキーとUp Arrowキーを押して目的の出力形式をハイライトし、 Enterを押します。

? Default Output Format: [Use arrows to move, type to filter]
> plaintext
json
オプション
説明
plaintext
Atlas CLI が返すすべてのフィールドを含む、人間が判読可能な出力。
json
MongoDB CLI が返すすべてのフィールドを含む JSON 出力。
6

Atlas CLI は指定されたmongoshパスを使用して配置にアクセスできます。 デフォルト値は/usr/local/bin/mongoshです。 デフォルトを受け入れるにはEnterを押し、またはシステム上のmongoshへのパスを指定してEnterを押します。

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
7

プロファイルを確認するには、構成ファイルを表示するか、 atlas config describeコマンドを実行します。 デフォルト プロファイルの場合、 <profileName>defaultです。

atlas config describe <profileName>

このコマンドは、次の設定を返します。 Atlas CLI は、セキュリティのためにAPIキーの値を編集します。

SETTING VALUE
"mongosh_path": "/usr/local/bin/mongosh",
"org_id": "60c9877baf349d6fc4fd9744",
"output": "json",
"private_api_key": "redacted",
"project_id": "60c94857241ae99848af45ad",
"public_api_key": "redacted",
"service": "cloud"

構成ファイルに保存されている設定は、次の方法でアップデートできます。

  • テキスト エディターを使用してconfig.tomlファイルを編集します。

  • 設定にはatlas config setコマンドを実行します。 これにより、 config.tomlファイル内の個々の値が編集されます。

プロファイルを使用して Atlas CLI コマンドを実行するには、次のようにします。

  • プロファイルを作成します。

  • コマンドに--profile <profileName>フラグを追加するか、 --profile <profileName>フラグを省略してデフォルトのプロファイルを使用します。

このコマンドは、 myProfileという名前のプロファイルを使用します。

atlas <command> --profile myProfile

このコマンドは、デフォルトの プロファイルを使用します。

atlas <command>

戻る

接続