feat: use LINGO_API_KEY as primary env var, deprecate LINGODOTDEV_API_KEY

Author: AndreyHirsa

packages/cli/src/cli/cmd/ci/index.ts

@@ -74,7 +74,7 @@ export default new Command()
 
     if (!settings.auth.apiKey) {
       console.error(
-        "No API key provided. Set LINGODOTDEV_API_KEY environment variable or use --api-key flag.",
+        "No API key provided. Set LINGO_API_KEY environment variable or use --api-key flag.",
       );
       return;
     }

packages/cli/src/cli/cmd/ci/platforms/_base.ts

@@ -47,6 +47,7 @@ export abstract class PlatformKit<
 
   get config() {
     const env = Z.object({
+      LINGO_API_KEY: Z.string().optional(),
       LINGODOTDEV_API_KEY: Z.string().optional(),
       LINGODOTDEV_PULL_REQUEST: Z.preprocess(
         (val) => val === "true" || val === true,
@@ -68,7 +69,7 @@ export abstract class PlatformKit<
     }).parse(process.env);
 
     return {
-      replexicaApiKey: env.LINGODOTDEV_API_KEY || "",
+      replexicaApiKey: env.LINGO_API_KEY || env.LINGODOTDEV_API_KEY || "",
       isPullRequestMode: env.LINGODOTDEV_PULL_REQUEST,
       commitMessage: env.LINGODOTDEV_COMMIT_MESSAGE || defaultMessage,
       pullRequestTitle: env.LINGODOTDEV_PULL_REQUEST_TITLE || defaultMessage,

packages/cli/src/cli/cmd/login.ts

@@ -49,7 +49,7 @@ Press Enter to open the browser for authentication.
 
 ---
 
-Having issues? Put LINGODOTDEV_API_KEY in your .env file instead.
+Having issues? Put LINGO_API_KEY in your .env file instead.
     `.trim() + "\n",
     );
 

packages/cli/src/cli/localizer/lingodotdev.ts

@@ -21,7 +21,7 @@ export default function createLingoDotDevLocalizer(
         To fix this issue:
         1. Run ${chalk.dim("lingo.dev login")} to authenticate, or
         2. Use the ${chalk.dim("--api-key")} flag to provide an API key.
-        3. Set ${chalk.dim("LINGODOTDEV_API_KEY")} environment variable.
+        3. Set ${chalk.dim("LINGO_API_KEY")} environment variable.
       `,
     );
   }

packages/cli/src/cli/utils/init-ci-cd.ts

@@ -105,7 +105,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: lingodotdev/lingo.dev@main
         with:
-          api-key: \${{ secrets.LINGODOTDEV_API_KEY }}
+          api-key: \${{ secrets.LINGO_API_KEY }}
 `,
     },
     spinner,

packages/cli/src/cli/utils/settings.ts

@@ -23,8 +23,10 @@ export function getSettings(explicitApiKey: string | undefined): CliSettings {
         env.LINGO_API_KEY ||
         env.LINGODOTDEV_API_KEY ||
         systemFile.auth?.apiKey ||
+        systemFile.auth?.vnext?.apiKey ||
         defaults.auth.apiKey,
       apiUrl:
+        env.LINGO_API_URL ||
         env.LINGODOTDEV_API_URL ||
         systemFile.auth?.apiUrl ||
         defaults.auth.apiUrl,
@@ -98,10 +100,11 @@ function _loadDefaults(): CliSettings {
 
 function _loadEnv() {
   return Z.looseObject({
+    LINGO_API_KEY: Z.string().optional(),
+    LINGO_API_URL: Z.string().optional(),
     LINGODOTDEV_API_KEY: Z.string().optional(),
     LINGODOTDEV_API_URL: Z.string().optional(),
     LINGODOTDEV_WEB_URL: Z.string().optional(),
-    LINGO_API_KEY: Z.string().optional(),
     OPENAI_API_KEY: Z.string().optional(),
     ANTHROPIC_API_KEY: Z.string().optional(),
     GROQ_API_KEY: Z.string().optional(),
@@ -123,6 +126,9 @@ function _loadSystemFile() {
       apiKey: Z.string().optional(),
       apiUrl: Z.string().optional(),
       webUrl: Z.string().optional(),
+      vnext: Z.object({
+        apiKey: Z.string().optional(),
+      }).optional(),
     }).optional(),
     llm: Z.looseObject({
       openaiApiKey: Z.string().optional(),
@@ -151,14 +157,40 @@ function _getSettingsFilePath(): string {
 function _legacyEnvVarWarning() {
   const env = _loadEnv();
 
-  if (env.REPLEXICA_API_KEY && !env.LINGODOTDEV_API_KEY) {
+  if (env.REPLEXICA_API_KEY && !env.LINGO_API_KEY && !env.LINGODOTDEV_API_KEY) {
     console.warn(
       "\x1b[33m%s\x1b[0m",
       `
 ⚠️  WARNING: REPLEXICA_API_KEY env var is deprecated ⚠️
 ===========================================================
 
-Please use LINGODOTDEV_API_KEY instead.
+Please use LINGO_API_KEY instead.
+===========================================================
+`,
+    );
+  }
+
+  if (env.LINGODOTDEV_API_KEY && !env.LINGO_API_KEY) {
+    console.warn(
+      "\x1b[33m%s\x1b[0m",
+      `
+⚠️  WARNING: LINGODOTDEV_API_KEY env var is deprecated ⚠️
+===========================================================
+
+Please use LINGO_API_KEY instead.
+===========================================================
+`,
+    );
+  }
+
+  if (env.LINGODOTDEV_API_URL && !env.LINGO_API_URL) {
+    console.warn(
+      "\x1b[33m%s\x1b[0m",
+      `
+⚠️  WARNING: LINGODOTDEV_API_URL env var is deprecated ⚠️
+===========================================================
+
+Please use LINGO_API_URL instead.
 ===========================================================
 `,
     );
@@ -211,10 +243,10 @@ function _envVarsInfo() {
       `ℹ️  Using MISTRAL_API_KEY env var instead of key from user config`,
     );
   }
-  if (env.LINGODOTDEV_API_URL) {
+  if (env.LINGO_API_URL || env.LINGODOTDEV_API_URL) {
     console.info(
       "\x1b[36m%s\x1b[0m",
-      `ℹ️  Using LINGODOTDEV_API_URL: ${env.LINGODOTDEV_API_URL}`,
+      `ℹ️  Using custom API URL: ${env.LINGO_API_URL || env.LINGODOTDEV_API_URL}`,
     );
   }
   if (env.LINGODOTDEV_WEB_URL) {
@@ -223,4 +255,10 @@ function _envVarsInfo() {
       `ℹ️  Using LINGODOTDEV_WEB_URL: ${env.LINGODOTDEV_WEB_URL}`,
     );
   }
+  if (env.LINGO_API_KEY && systemFile.auth?.vnext?.apiKey) {
+    console.info(
+      "\x1b[36m%s\x1b[0m",
+      `ℹ️  Using LINGO_API_KEY env var instead of key from user config`,
+    );
+  }
 }