Add documentation for supported config file extensions

Copilot · dlevy-msft-sql · Copilot · commit e3d9c23ab6c0 · 2026-01-31T19:57:24.000Z
Co-authored-by: dlevy-msft-sql &lt;194277063+dlevy-msft-sql@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -82,6 +82,24 @@ sqlcmd config connection-strings
 sqlcmd config view
 ```
 
+#### Custom Configuration Files
+
+You can specify a custom configuration file using the `--sqlconfig` flag. The configuration file must use one of the following supported file extensions:
+- `.yaml` or `.yml` (YAML format)
+- `.json` (JSON format)
+- `.toml` (TOML format)
+- `.ini` (INI format)
+- `.env` (Dotenv format)
+- `.properties` (Properties format)
+
+Example:
+```
+sqlcmd config --sqlconfig ./myproject.yaml add-endpoint --name ep1434 --address localhost --port 1434
+sqlcmd config --sqlconfig ./myproject.yaml view
+```
+
+**Note:** Using unsupported file extensions (like `.sqlconfig`) will result in an "Unsupported Config Type" error when modifying the configuration. The default configuration file at `~/.sqlcmd/sqlconfig` uses YAML format without an extension.
+
 ### Versions
 
 To see all version tags to choose from (2017, 2019, 2022 etc.), and install a specific version, run:
diff --git a/cmd/modern/root.go b/cmd/modern/root.go
@@ -121,7 +121,7 @@ func (c *Root) addGlobalFlags() {
 		String:        &c.configFilename,
 		DefaultString: config.DefaultFileName(),
 		Name:          "sqlconfig",
-		Usage:         localizer.Sprintf("configuration file"),
+		Usage:         localizer.Sprintf("configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)"),
 	})
 
 	/* BUG(stuartpa): - At the moment this is a top level flag, but it doesn't
diff --git a/internal/translations/catalog.go b/internal/translations/catalog.go
diff --git a/internal/translations/locales/de-DE/out.gotext.json b/internal/translations/locales/de-DE/out.gotext.json
@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "Konfigurationsdatei",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
@@ -2403,27 +2401,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Drücken Sie STRG+C, um diesen Prozess zu beenden...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "Der Fehler \"Not enough memory resources are available\" (Nicht genügend Arbeitsspeicherressourcen sind verfügbar) kann durch zu viele Anmeldeinformationen verursacht werden, die bereits in Windows Anmeldeinformations-Manager gespeichert sind",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "Fehler beim Schreiben der Anmeldeinformationen in Windows Anmeldeinformations-Manager",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/en-US/out.gotext.json b/internal/translations/locales/en-US/out.gotext.json
@@ -47,9 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "configuration file",
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
@@ -2403,27 +2403,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Press Ctrl+C to exit this process...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "Failed to write credential to Windows Credential Manager",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/es-ES/out.gotext.json b/internal/translations/locales/es-ES/out.gotext.json
@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "archivo de configuración",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
@@ -2403,27 +2401,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Presione Ctrl+C para salir de este proceso...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "Un error \"No hay suficientes recursos de memoria disponibles\" puede deberse a que ya hay demasiadas credenciales almacenadas en Windows Administrador de credenciales",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "No se pudo escribir la credencial en Windows Administrador de credenciales",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/fr-FR/out.gotext.json b/internal/translations/locales/fr-FR/out.gotext.json
@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "fichier de configuration",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
@@ -2403,27 +2401,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Appuyez sur Ctrl+C pour quitter ce processus...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "Une erreur \"Pas assez de ressources mémoire disponibles\" peut être causée par trop d'informations d'identification déjà stockées dans Windows Credential Manager",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "Échec de l'écriture des informations d'identification dans le gestionnaire d'informations d'identification Windows",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/it-IT/out.gotext.json b/internal/translations/locales/it-IT/out.gotext.json
@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "file di configurazione",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
@@ -2403,27 +2401,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Premere CTRL+C per uscire dal processo...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "Un errore 'Risorse di memoria insufficienti' può essere causato da troppe credenziali già archiviate in Gestione credenziali di Windows",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "Impossibile scrivere le credenziali in Gestione credenziali di Windows",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/ja-JP/out.gotext.json b/internal/translations/locales/ja-JP/out.gotext.json
@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "構成ファイル",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
@@ -2403,27 +2401,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Ctrl + C を押して、このプロセスを終了します...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "Windows 資格情報マネージャーに既に格納されている資格情報が多すぎるため、'十分なメモリ リソースがありません' というエラーが発生した可能性があります",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "Windows 資格情報マネージャーに資格情報を書き込めませんでした",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/ko-KR/out.gotext.json b/internal/translations/locales/ko-KR/out.gotext.json
@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "구성 파일",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
@@ -2403,27 +2401,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Ctrl+C를 눌러 이 프로세스를 종료합니다...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "Windows 자격 증명 관리자에 이미 저장된 자격 증명이 너무 많으면 '사용 가능한 메모리 리소스가 부족합니다' 오류가 발생할 수 있습니다.",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "Windows 자격 증명 관리자에 자격 증명을 쓰지 못했습니다.",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/pt-BR/out.gotext.json b/internal/translations/locales/pt-BR/out.gotext.json
@@ -47,11 +47,9 @@
             "fuzzy": true
         },
         {
-            "id": "configuration file",
-            "message": "configuration file",
-            "translation": "Arquivo de configuração:",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
+            "id": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "message": "configuration file (supported extensions: .yaml, .yml, .json, .toml, .ini, .env, .properties)",
+            "translation": ""
         },
         {
             "id": "log level, error=0, warn=1, info=2, debug=3, trace=4",
@@ -2403,27 +2401,6 @@
             "translatorComment": "Copied from source.",
             "fuzzy": true
         },
-        {
-            "id": "Press Ctrl+C to exit this process...",
-            "message": "Press Ctrl+C to exit this process...",
-            "translation": "Pressione Ctrl+C para sair desse processo...",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "message": "A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager",
-            "translation": "Um erro \"Não há recursos de memória suficientes disponíveis\" pode ser causado por ter muitas credenciais já armazenadas no Gerenciador de Credenciais do Windows",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
-        {
-            "id": "Failed to write credential to Windows Credential Manager",
-            "message": "Failed to write credential to Windows Credential Manager",
-            "translation": "Falha ao gravar credencial no Gerenciador de Credenciais do Windows",
-            "translatorComment": "Copied from source.",
-            "fuzzy": true
-        },
         {
             "id": "The -L parameter can not be used in combination with other parameters.",
             "message": "The -L parameter can not be used in combination with other parameters.",
diff --git a/internal/translations/locales/ru-RU/out.gotext.json b/internal/translations/locales/ru-RU/out.gotext.json
diff --git a/internal/translations/locales/zh-CN/out.gotext.json b/internal/translations/locales/zh-CN/out.gotext.json
diff --git a/internal/translations/locales/zh-TW/out.gotext.json b/internal/translations/locales/zh-TW/out.gotext.json
