i18nexus-cli 3.4.0 → 3.5.0

package/README.md

@@ -130,14 +130,15 @@ Translations for the string will be automatically generated and machine translat
 
 ### Options
 
-| Option                 | Required? |
-| ---------------------- | --------- |
-| `--api-key` or `-k`    | ✔  |
-| `--pat` or `-t`        | ✔  |
-| `--namespace` or `-ns` | ✔  |
-| `--key` or `-K`        | ✔  |
-| `--value` or `-v`      | ✔  |
-| `--details` or `-d`    |           |
+| Option                       | Required? |
+| ---------------------------- | --------- |
+| `--api-key` or `-k`          | ✔  |
+| `--pat` or `-t`              | ✔  |
+| `--namespace` or `-ns`       | ✔  |
+| `--key` or `-K`              | ✔  |
+| `--value` or `-v`            | ✔  |
+| `--details` or `-d`          |           |
+| `--ai-instructions` or `-ai` |           |
 
 ### Notes
 
@@ -159,6 +160,9 @@ The value of the string to create
 `--details`
 The details of the string to create (optional)
 
+`--ai-instructions`
+Instructions or context for AI machine translator (optional)
+
 ## Updating existing strings
 
 `i18nexus update-string <namespace> <key>` or `i18nexus u <namespace> <key>`
@@ -175,16 +179,17 @@ You can then update the key, value, details, and/or namespace by using the comma
 
 ### Options
 
-| Option                 | Required? |
-| ---------------------- | --------- |
-| `--api-key` or `-k`    | &#10004;  |
-| `--pat` or `-t`        | &#10004;  |
-| `--namespace` or `-ns` |           |
-| `--key` or `-K`        |           |
-| `--value` or `-v`      |           |
-| `--details` or `-d`    |           |
-| `--reset-confirmed`    |           |
-| `--retain-confirmed`   |           |
+| Option                       | Required? |
+| ---------------------------- | --------- |
+| `--api-key` or `-k`          | &#10004;  |
+| `--pat` or `-t`              | &#10004;  |
+| `--namespace` or `-ns`       |           |
+| `--key` or `-K`              |           |
+| `--value` or `-v`            |           |
+| `--details` or `-d`          |           |
+| `--ai-instructions` or `-ai` |           |
+| `--reset-confirmed`          |           |
+| `--retain-confirmed`         |           |
 
 ### Notes
 
@@ -206,6 +211,9 @@ The new value of the string
 `--details`
 The new details of the string
 
+`--ai-instructions`
+Instructions or context for AI machine translator
+
 #### If you are updating the value of a string that contains translations that have been marked confirmed in i18nexus, you will be required to include one of the following options to your command:
 
 `--reset-confirmed`

package/bin/index.js

@@ -83,6 +83,10 @@ program
     '-d, --details <stringDetails>',
     'The details of the string to create (optional)'
   )
+  .option(
+    '-ai, --ai-instructions <stringAiInstructions>',
+    'Instructions/Context for AI machine translator (optional)'
+  )
   .action(options => {
     addString({
       key: options.key,
@@ -90,7 +94,8 @@ program
       details: options.details,
       namespace: options.namespace,
       apiKey: options.apiKey,
-      pat: options.pat
+      pat: options.pat,
+      aiInstructions: options.aiInstructions
     });
   });
 
@@ -115,6 +120,10 @@ program
     'The new namespace of the string'
   )
   .option('-d, --details <stringDetails>', 'The new details of the string')
+  .option(
+    '-ai, --ai-instructions <stringAiInstructions>',
+    'Instructions/Context for AI machine translator (optional)'
+  )
   .option(
     '--reset-confirmed',
     'Reset confirmed translations of this string with machine translations.'
@@ -132,6 +141,7 @@ program
       key: options.key,
       value: options.value,
       details: options.details,
+      aiInstructions: options.aiInstructions,
       namespace: options.namespace,
       apiKey: options.apiKey,
       pat: options.pat,

package/commands/addString.js

@@ -14,7 +14,8 @@ const addString = async opt => {
       key: opt.key,
       value: opt.value,
       namespace: opt.namespace,
-      description: opt.details
+      description: opt.details,
+      ai_instructions: opt.aiInstructions
     }),
     headers: {
       Authorization: `Bearer ${opt.pat}`,

package/commands/updateString.js

@@ -29,6 +29,7 @@ const addString = async opt => {
       value: opt.value,
       namespace: opt.namespace,
       description: opt.details,
+      ai_instructions: opt.aiInstructions,
       reset_confirmed: resetConfirmed
     }),
     headers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18nexus-cli",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Command line interface (CLI) for accessing the i18nexus API",
   "main": "index.js",
   "bin": {
@@ -9,7 +9,9 @@
   "keywords": [
     "i18nexus",
     "cli",
-    "i18next"
+    "react-intl",
+    "i18next",
+    "next-intl"
   ],
   "author": "i18nexus",
   "license": "MIT",