i18nexus-cli 3.8.3 → 4.1.0

package/README.md

@@ -49,17 +49,6 @@ If your i18nexus project is set to **`i18next`**:
             └── common.json
 ```
 
-If your i18nexus project is set to **`i18next`** and the CLI detects you're using **Next.js + App Router**:
-
-```
-.
-└── locales
-    ├── en
-    |   └── common.json
-    └── de
-        └── common.json
-```
-
 If your i18nexus project is set to **`next-intl`**:
 
 ```
@@ -125,6 +114,41 @@ Before download, clears your destination folder specified in --path. As a safety
 `--compact`
 Output JSON without extra whitespace (default is pretty-printed)
 
+## Viewing project metadata
+
+`i18nexus project`
+
+```sh
+i18nexus project -k <PROJECT_API_KEY>
+```
+
+The above snippet prints your i18nexus project metadata as formatted JSON. This is useful for checking your project title, base language, enabled namespaces, and configured languages from the command line.
+
+Example output:
+
+```json
+{
+  "id": 123,
+  "title": "My Project",
+  "library": "i18next",
+  "language": "en",
+  "languages": ["de"],
+  "use_namespaces": true,
+  "namespaces": ["common", "auth"]
+}
+```
+
+### Options
+
+| Option              | Required? |
+| ------------------- | --------- |
+| `--api-key` or `-k` | &#10004;  |
+
+### Notes
+
+`--api-key`
+Your project API key (Can also be set using environment variable `I18NEXUS_API_KEY`)
+
 ## Personal Access Tokens
 
 The following commands require a Personal Access Token (PAT) because they write data to your i18nexus project. PATs are created in your i18nexus account dashboard.
@@ -143,6 +167,8 @@ The above snippet will create a new string in your i18nexus project in your `com
 
 Translations for the string will be automatically generated and machine translated for all of your project's languages, just as if you added the string manually in the i18nexus web application.
 
+If you want to add multiple strings at once, see `i18nexus bulk-add-strings` and `i18nexus import`.
+
 ### Options
 
 | Option                       | Required?     |
@@ -297,6 +323,56 @@ The namespace in which your strings will be imported. (Only required if your pro
 `--overwrite`
 If any keys already exist in the target namespace, overwrite the values with the imported values.
 
+## Adding multiple strings
+
+`i18nexus bulk-add-strings <filePath>` or `i18nexus ba <filePath>`
+
+```sh
+i18nexus ba ./base-strings.json -ns common -k <PROJECT_API_KEY> -t <YOUR_PERSONAL_ACCESS_TOKEN>
+```
+
+The above snippet will create multiple new strings in your i18nexus project from a local JSON file.
+
+Use this command when you want to create strings with `notes` and/or `ai_instructions`. If you only need to import plain key/value JSON, use `i18nexus import` instead.
+
+The JSON file must contain a top-level array of objects. Each object should include `key` and `value`, and can optionally include `notes` and `ai_instructions`.
+
+```json
+[
+  {
+    "key": "welcome_title",
+    "value": "Welcome to my app",
+    "notes": "Homepage hero title"
+  },
+  {
+    "key": "welcome_cta",
+    "value": "Get started",
+    "ai_instructions": "Use action-oriented onboarding language"
+  }
+]
+```
+
+If a key already exists in the target namespace, it will be skipped and reported back by the CLI.
+
+### Options
+
+| Option                 | Required?     |
+| ---------------------- | ------------- |
+| `--api-key` or `-k`    | &#10004;      |
+| `--pat` or `-t`        | &#10004;      |
+| `--namespace` or `-ns` | Conditionally |
+
+### Notes
+
+`--api-key`
+Your project API key (Can also be set using environment variable `I18NEXUS_API_KEY`)
+
+`--pat`
+A personal access token that you have generated in your i18nexus account (Can also be set using environment variable `I18NEXUS_PERSONAL_ACCESS_TOKEN`)
+
+`--namespace`
+The namespace in which to create the strings. Only required if your project uses namespaces and has more than one namespace.
+
 ## Adding new namespaces
 
 `i18nexus add-namespace <namespaceTitle>`

package/bin/index.js

@@ -3,7 +3,9 @@ const pkg = require('../package.json');
 
 const program = require('commander');
 const pull = require('../commands/pull');
+const project = require('../commands/project');
 const addString = require('../commands/addString');
+const bulkAddStrings = require('../commands/bulkAddStrings');
 const updateString = require('../commands/updateString');
 const deleteString = require('../commands/deleteString');
 const importJson = require('../commands/importJson');
@@ -20,6 +22,20 @@ if (process.env.I18NEXUS_NO_DOT_ENV !== 'true') {
 
 program.version(pkg.version);
 
+program
+  .command('project')
+  .description('Show metadata about your i18nexus project as JSON')
+  .requiredOption(
+    '-k, --api-key <apiKey>',
+    'The API key for your project',
+    process.env.I18NEXUS_API_KEY
+  )
+  .action(options => {
+    project({
+      apiKey: options.apiKey
+    });
+  });
+
 program
   .command('pull')
   .description('Download all translations as .json files')
@@ -106,6 +122,33 @@ program
     });
   });
 
+program
+  .command('bulk-add-strings <filePath>')
+  .alias('ba')
+  .description('Add multiple base strings to a namespace from a local JSON file')
+  .requiredOption(
+    '-k, --api-key <apiKey>',
+    'The API key for your project',
+    process.env.I18NEXUS_API_KEY
+  )
+  .requiredOption(
+    '-t, --pat <personalAccessToken>',
+    'A personal access token generated for your account in i18nexus.',
+    process.env.I18NEXUS_PERSONAL_ACCESS_TOKEN
+  )
+  .option(
+    '-ns, --namespace <stringNamespace>',
+    'The namespace in which to create the strings (Only required if your project uses namespaces and has more than one namespace)'
+  )
+  .action((filePath, options) => {
+    bulkAddStrings({
+      path: filePath,
+      namespace: options.namespace,
+      apiKey: options.apiKey,
+      pat: options.pat
+    });
+  });
+
 program
   .command('update-string <namespace:key>')
   .alias('u')

package/commands/bulkAddStrings.js

@@ -0,0 +1,75 @@
+const fs = require('fs');
+const path = require('path');
+const colors = require('colors');
+const handleError = require('../handleError');
+const handleFetch = require('../handleFetch');
+const baseUrl = require('../baseUrl');
+
+const bulkAddStrings = async opt => {
+  let url = `${baseUrl}/project_resources/base_strings/bulk_create.json`;
+
+  url += `?api_key=${opt.apiKey}`;
+
+  if (!fs.existsSync(opt.path)) {
+    console.log(colors.red(`File not found: ${opt.path}`));
+    process.exit(1);
+  }
+
+  if (path.extname(opt.path) !== '.json') {
+    console.log(colors.red(`File is not .json: ${opt.path}`));
+    process.exit(1);
+  }
+
+  const fileData = fs.readFileSync(opt.path);
+
+  let baseStrings;
+  try {
+    baseStrings = JSON.parse(fileData);
+  } catch (e) {
+    console.log(colors.red('Invalid JSON'));
+    process.exit(1);
+  }
+
+  if (!Array.isArray(baseStrings)) {
+    console.log(colors.red('Invalid JSON: expected a top-level array of base string objects'));
+    process.exit(1);
+  }
+
+  const normalizedBaseStrings = baseStrings.map(baseString => ({
+    ...baseString,
+    description: baseString.notes ?? baseString.description
+  }));
+
+  const response = await handleFetch(url, {
+    method: 'POST',
+    body: JSON.stringify({
+      namespace: opt.namespace,
+      base_strings: normalizedBaseStrings
+    }),
+    headers: {
+      Authorization: `Bearer ${opt.pat}`,
+      'Content-Type': 'application/json'
+    }
+  });
+
+  if (response.status !== 200) {
+    return handleError(response);
+  }
+
+  const json = await response.json();
+  const invalidKeys = json.base_strings_invalid_values || [];
+
+  console.log(
+    colors.green(`Successfully submitted strings from ${opt.path} for import`)
+  );
+
+  if (invalidKeys.length > 0) {
+    console.log(
+      colors.yellow(
+        `Skipped existing keys: ${invalidKeys.join(', ')}`
+      )
+    );
+  }
+};
+
+module.exports = bulkAddStrings;

package/commands/project.js

@@ -0,0 +1,22 @@
+const handleError = require('../handleError');
+const handleFetch = require('../handleFetch');
+const baseUrl = require('../baseUrl');
+
+const project = async opt => {
+  const url = `${baseUrl}/project_resources/project.json?api_key=${opt.apiKey}`;
+
+  const response = await handleFetch(url);
+
+  if (response.status !== 200) {
+    return handleError(
+      response,
+      'There was a problem fetching your project. Please try again in a moment.'
+    );
+  }
+
+  const json = await response.json();
+
+  console.log(JSON.stringify(json, null, 2));
+};
+
+module.exports = project;

package/commands/pull.js

@@ -45,20 +45,7 @@ const pull = async (opt, internalOptions = {}) => {
     }
 
     if (projectLibrary === 'i18next') {
-      const hasAppDir =
-        fs.existsSync(`${process.cwd()}/app`) ||
-        fs.existsSync(`${process.cwd()}/src/app`);
-      const usingAppRouter =
-        hasAppDir &&
-        (fs.existsSync(`${process.cwd()}/.next`) ||
-          fs.existsSync(`${process.cwd()}/next.config.js`) ||
-          fs.existsSync(`${process.cwd()}/next.config.ts`));
-
-      if (usingAppRouter) {
-        path = `${process.cwd()}/locales`;
-      } else {
-        path = `${process.cwd()}/public/locales`;
-      }
+      path = `${process.cwd()}/public/locales`;
     } else if (projectLibrary === 'react-intl') {
       const hasSrcDir = fs.existsSync(`${process.cwd()}/src`);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18nexus-cli",
-  "version": "3.8.3",
+  "version": "4.1.0",
   "description": "Command line interface (CLI) for accessing the i18nexus API",
   "main": "index.js",
   "bin": {