@algolia/cli 4.0.8 → 5.10.0

package/README.md

@@ -0,0 +1,42 @@
+# Algolia CLI
+
+The official Algolia CLI lets you manage your Algolia resources — indices, records, API keys, and synonyms — directly from the command line.
+
+> This package installs a prebuilt Go binary. The npm wrapper still requires Node.js to launch the installed command.
+
+## Installation
+
+```sh
+npm install -g @algolia/cli
+```
+
+Or run without installing:
+
+```sh
+npx @algolia/cli --help
+```
+
+## Usage
+
+```sh
+algolia --help
+algolia search --index my-index --query "foo"
+algolia indices list
+algolia apikeys list
+```
+
+## Documentation
+
+Full documentation: [algolia.com/doc/tools/cli](https://algolia.com/doc/tools/cli/)
+
+## Supported platforms
+
+| OS      | x64 | arm64 |
+|---------|-----|-------|
+| macOS   | ✓   | ✓     |
+| Linux   | ✓   | ✓     |
+| Windows | ✓   | ✓     |
+
+## Issues
+
+[github.com/algolia/cli/issues](https://github.com/algolia/cli/issues)

package/bin/run.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+'use strict';
+
+const { execFileSync } = require('child_process');
+
+let binPath;
+switch (`${process.platform}-${process.arch}`) {
+  case 'darwin-x64':   ({ binPath } = require('@algolia/cli-darwin-x64'));   break;
+  case 'darwin-arm64': ({ binPath } = require('@algolia/cli-darwin-arm64')); break;
+  case 'linux-x64':    ({ binPath } = require('@algolia/cli-linux-x64'));    break;
+  case 'linux-arm64':  ({ binPath } = require('@algolia/cli-linux-arm64'));  break;
+  case 'win32-x64':    ({ binPath } = require('@algolia/cli-win32-x64'));    break;
+  case 'win32-arm64':  ({ binPath } = require('@algolia/cli-win32-arm64'));  break;
+  default:
+    console.error(
+      `algolia: unsupported platform ${process.platform}/${process.arch}\n` +
+      `Install the appropriate platform package manually: npm install @algolia/cli-${process.platform}-${process.arch}`
+    );
+    process.exit(1);
+}
+
+try {
+  execFileSync(binPath, process.argv.slice(2), { stdio: 'inherit' });
+} catch (e) {
+  process.exit(e.status ?? 1);
+}

package/package.json

@@ -1,90 +1,38 @@
 {
   "name": "@algolia/cli",
-  "version": "4.0.8",
-  "description": "A Node CLI tools for manipulating data. Handy for day-to-day Algolia SE work.",
-  "license": "ISC",
-  "author": "Algolia, Inc. (https://www.algolia.com)",
-  "main": "index.js",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/algolia/algolia-cli.git"
-  },
+  "version": "5.10.0",
+  "description": "The official Algolia CLI — manage indices, records, API keys, and synonyms from the command line",
   "bin": {
-    "algolia": "./index.js"
-  },
-  "scripts": {
-    "test": "jest --runInBand",
-    "test:unit": "jest commands/",
-    "test:unit:watch": "jest --watch commands/",
-    "test:integration": "jest --runInBand tests/integration/",
-    "lint": "eslint .",
-    "lint:fix": "npm run lint -- --fix"
-  },
-  "engines": {
-    "node": ">=8.9.1",
-    "yarn": ">=1.10.1"
+    "algolia": "bin/run.js"
   },
   "files": [
-    "commands",
-    "commands.js",
-    "index.js",
-    "!commands/*.test.js"
+    "bin/run.js",
+    "README.md"
   ],
-  "renovate": {
-    "extends": [
-      "config:js-app"
-    ]
+  "optionalDependencies": {
+    "@algolia/cli-darwin-x64": "5.10.0",
+    "@algolia/cli-darwin-arm64": "5.10.0",
+    "@algolia/cli-linux-x64": "5.10.0",
+    "@algolia/cli-linux-arm64": "5.10.0",
+    "@algolia/cli-win32-x64": "5.10.0",
+    "@algolia/cli-win32-arm64": "5.10.0"
   },
   "keywords": [
-    "data",
-    "json",
-    "csv",
-    "manipulate",
-    "transform",
-    "process",
-    "parse",
-    "import",
-    "index",
-    "solutions",
-    "se",
-    "cli"
+    "algolia",
+    "cli",
+    "search",
+    "indices",
+    "records",
+    "api-keys",
+    "synonyms"
   ],
-  "dependencies": {
-    "JSONStream": "^1.3.5",
-    "algoliasearch": "^3.31.0",
-    "async": "^2.6.0",
-    "batch-stream": "^0.1.3",
-    "chalk": "^2.4.1",
-    "commander": "^2.19.0",
-    "csvtojson": "^2.0.8",
-    "inquirer": "^6.2.2",
-    "regex-parser": "^2.2.10",
-    "speedtest-net": "^1.5.1",
-    "stream-transform": "^1.0.7",
-    "through": "^2.3.8"
-  },
-  "devDependencies": {
-    "babel-eslint": "^10.0.1",
-    "babel-jest": "^23.6.0",
-    "dotenv": "^6.2.0",
-    "eslint": "^5.9.0",
-    "eslint-config-algolia": "^13.2.3",
-    "eslint-config-prettier": "^3.3.0",
-    "eslint-plugin-import": "^2.14.0",
-    "eslint-plugin-jest": "^22.1.2",
-    "eslint-plugin-prettier": "^3.0.0",
-    "jest": "^23.6.0",
-    "prettier": "^1.15.3",
-    "randomatic": "^3.1.1",
-    "rimraf": "^2.6.2",
-    "striptags": "^3.1.1"
+  "license": "MIT",
+  "homepage": "https://algolia.com/doc/tools/cli/",
+  "bugs": {
+    "url": "https://github.com/algolia/cli/issues"
   },
-  "jest": {
-    "testEnvironment": "node",
-    "verbose": true,
-    "testURL": "http://localhost/",
-    "setupFiles": [
-      "./tests/config.js"
-    ]
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/algolia/cli.git"
   }
 }

package/commands/AddRules.js

@@ -1,72 +0,0 @@
-const fs = require('fs');
-const algolia = require('algoliasearch');
-const Base = require('./Base.js');
-
-class AddRulesScript extends Base {
-  constructor() {
-    super();
-    // Bind class methods
-    this.getSource = this.getSource.bind(this);
-    this.parseBatchRulesOptions = this.parseBatchRulesOptions.bind(this);
-    this.start = this.start.bind(this);
-    // Define validation constants
-    this.message =
-      '\nExample: $ algolia addrules -a algoliaappid -k algoliaapikey -n algoliaindexname -s sourcefilepath -p batchRulesParams\n\n';
-    this.params = [
-      'algoliaappid',
-      'algoliaapikey',
-      'algoliaindexname',
-      'sourcefilepath',
-    ];
-  }
-
-  getSource(path) {
-    const filepath = this.normalizePath(path);
-    if (!fs.lstatSync(filepath).isFile())
-      throw new Error('Source filepath must target valid rules file.');
-    return filepath;
-  }
-
-  parseBatchRulesOptions(params) {
-    try {
-      const options = { forwardToReplicas: false, clearExistingRules: false };
-      if (params === null) return options;
-      else return JSON.parse(params);
-    } catch (e) {
-      throw e;
-    }
-  }
-
-  async start(program) {
-    try {
-      // Validate command; if invalid display help text and exit
-      this.validate(program, this.message, this.params);
-
-      // Config params
-      const appId = program.algoliaappid;
-      const apiKey = program.algoliaapikey;
-      const indexName = program.algoliaindexname;
-      const sourcefilepath = program.sourcefilepath;
-      const params = program.params || null;
-
-      // Get rules
-      const rulesPath = this.getSource(sourcefilepath);
-      const rulesFile = await fs.readFileSync(rulesPath);
-      const rules = JSON.parse(rulesFile);
-      // Get options
-      const batchRulesOptions = this.parseBatchRulesOptions(params);
-
-      // Instantiate Algolia index
-      const client = algolia(appId, apiKey);
-      const index = client.initIndex(indexName);
-      // Add rules
-      const result = await index.batchRules(rules, batchRulesOptions);
-      return console.log(result);
-    } catch (e) {
-      throw e;
-    }
-  }
-}
-
-const addRulesScript = new AddRulesScript();
-module.exports = addRulesScript;

package/commands/AddSynonyms.js

@@ -1,89 +0,0 @@
-const fs = require('fs');
-const algolia = require('algoliasearch');
-const Base = require('./Base.js');
-
-class AddSynonymsScript extends Base {
-  constructor() {
-    super();
-    // Bind class methods
-    this.getSource = this.getSource.bind(this);
-    this.parseBatchSynonymsOptions = this.parseBatchSynonymsOptions.bind(this);
-    this.convertCsvToJson = this.convertCsvToJson.bind(this);
-    this.start = this.start.bind(this);
-    // Define validation constants
-    this.message =
-      '\nExample: $ algolia addsynonyms -a algoliaappid -k algoliaapikey -n algoliaindexname -s sourcefilepath -p batchSynonymsParams\n\n';
-    this.params = [
-      'algoliaappid',
-      'algoliaapikey',
-      'algoliaindexname',
-      'sourcefilepath',
-    ];
-  }
-
-  getSource(path) {
-    const filepath = this.normalizePath(path);
-    if (!fs.lstatSync(filepath).isFile())
-      throw new Error('Source filepath must target valid synonyms file.');
-    return filepath;
-  }
-
-  parseBatchSynonymsOptions(params) {
-    try {
-      const options = {
-        forwardToReplicas: false,
-        clearExistingSynonyms: false,
-      };
-      if (params === null) return options;
-      else return JSON.parse(params);
-    } catch (e) {
-      throw e;
-    }
-  }
-
-  convertCsvToJson(synonymFile, filepath) {
-    const synonyms = synonymFile.toString().split('\n');
-    return synonyms.map((line, num) => ({
-      type: 'synonym',
-      objectID: `${filepath}-${num}`,
-      synonyms: line.split(','),
-    }));
-  }
-
-  async start(program) {
-    try {
-      // Validate command; if invalid display help text and exit
-      this.validate(program, this.message, this.params);
-
-      // Config params
-      const appId = program.algoliaappid;
-      const apiKey = program.algoliaapikey;
-      const indexName = program.algoliaindexname;
-      const sourcefilepath = program.sourcefilepath;
-      const params = program.params || null;
-      const isCsv = sourcefilepath.split('.').pop() === 'csv';
-
-      // Get synonyms
-      const synonymsPath = this.getSource(sourcefilepath);
-      const synonymsFile = await fs.readFileSync(synonymsPath);
-      const synonyms = isCsv
-        ? this.convertCsvToJson(synonymsFile, sourcefilepath)
-        : JSON.parse(synonymsFile);
-
-      // Get options
-      const batchSynonymsOptions = this.parseBatchSynonymsOptions(params);
-
-      // Instantiate Algolia index
-      const client = algolia(appId, apiKey);
-      const index = client.initIndex(indexName);
-      // Add rules
-      const result = await index.batchSynonyms(synonyms, batchSynonymsOptions);
-      return console.log(result);
-    } catch (e) {
-      throw e;
-    }
-  }
-}
-
-const addSynonymsScript = new AddSynonymsScript();
-module.exports = addSynonymsScript;

package/commands/Base.js

@@ -1,97 +0,0 @@
-const os = require('os');
-const fs = require('fs');
-const path = require('path');
-const readLine = require('readline');
-const chalk = require('chalk');
-const speedTest = require('speedtest-net');
-
-class Base {
-  constructor() {
-    this.maxHeapMb = process.arch.includes('64') ? 1024 : 512;
-  }
-
-  validate(program, message, params) {
-    let flag = false;
-    let output = message;
-    params.forEach(param => {
-      if (!program[param]) {
-        output += chalk.red(`Must specify ${param}\n`);
-        flag = true;
-      }
-    });
-    if (flag) return program.help(h => h + output);
-    else return { flag, output };
-  }
-
-  writeProgress(message) {
-    readLine.clearLine(process.stdout, 0);
-    readLine.cursorTo(process.stdout, 0);
-    process.stdout.write(message);
-  }
-
-  normalizePath(input) {
-    // Convert path input param to valid system absolute path
-    // Path is absolute, originating from system root
-    if (path.isAbsolute(input)) return input;
-    // Path is relative to user's home directory
-    if (input[0] === '~') return path.join(os.homedir(), input.substr(1));
-    // Path is relative to current directory
-    return path.resolve(process.cwd(), input);
-  }
-
-  setSource(options) {
-    // Set source directory and filenames array
-    // Used to process path inputs that may either be a single file or a directory of files
-    const source = this.normalizePath(options.sourceFilepath);
-    if (fs.lstatSync(source).isDirectory()) {
-      this.directory = source;
-      this.filenames = fs.readdirSync(source);
-    } else if (fs.lstatSync(source).isFile()) {
-      this.directory = path.parse(source).dir;
-      this.filenames = [path.parse(source).base];
-    } else {
-      throw new Error('Invalid sourcefilepath param');
-    }
-  }
-
-  getMemoryUsage() {
-    const used = process.memoryUsage().heapUsed / 1024 / 1024;
-    const usedMb = Math.round(used * 100) / 100;
-    const percentUsed = Math.floor((usedMb / this.maxHeapMb) * 100);
-    return { usedMb, percentUsed };
-  }
-
-  getStringSizeMb(string) {
-    const bytes = Buffer.byteLength(string, 'utf8');
-    const mb = bytes / 1024 / 1024;
-    return Math.ceil(mb);
-  }
-
-  getNetworkSpeed() {
-    return new Promise((resolve, reject) => {
-      this.writeProgress('Estimating network speed...');
-      const test = speedTest({ maxTime: 5000 });
-      let downloadSpeedMb = null;
-      let uploadSpeedMb = null;
-      test.on('error', e => {
-        console.log(chalk.white.bgRed('Speed test error'), chalk.red(e));
-        reject(e);
-      });
-      test.on('downloadspeed', speed => {
-        downloadSpeedMb = ((speed * 125) / 1000).toFixed(2);
-      });
-      test.on('uploadspeed', speed => {
-        uploadSpeedMb = ((speed * 125) / 1000).toFixed(2);
-      });
-      test.on('done', () => {
-        console.log(
-          chalk.blue(`\nDownload: ${downloadSpeedMb} MB/s`),
-          chalk.blue(`\nUpload: ${uploadSpeedMb} MB/s`)
-        );
-        resolve(uploadSpeedMb);
-      });
-    });
-  }
-}
-
-module.exports = Base;

package/commands/DeleteIndicesPattern.js

@@ -1,104 +0,0 @@
-const algolia = require('algoliasearch');
-const Base = require('./Base.js');
-
-class DeleteIndicesPatternScript extends Base {
-  constructor() {
-    super();
-    // Define validation constants
-    this.message =
-      "\nUsage: $ algolia deleteindices -a algoliaappid -k algoliaapikey -r 'regexp for filtering' -x\n\n";
-    this.params = ['algoliaappid', 'algoliaapikey', 'regexp', 'dryrun'];
-  }
-
-  removeReplicas({ indices, regexp, dryRun }) {
-    return Promise.all(
-      indices.map(async ({ name: indexName }) => {
-        const index = await this.client.initIndex(indexName);
-        const indexSettings = await index.getSettings();
-        const replicas = indexSettings.slaves || indexSettings.replicas;
-        if (replicas !== undefined && replicas.length > 0) {
-          const newReplicas = replicas.filter(
-            replicaIndexName => regexp.test(replicaIndexName) === false
-          );
-
-          if (replicas.length !== newReplicas.length) {
-            if (dryRun === false) {
-              const { taskID } = await index.setSettings({
-                [indexSettings.slaves !== undefined
-                  ? 'slaves'
-                  : 'replicas']: newReplicas,
-              });
-              await index.waitTask(taskID);
-            } else {
-              console.log(
-                `[DRY RUN] Replicas change on index ${indexName}, \n- before: ${replicas.join(
-                  ','
-                )}\n- after: ${newReplicas.join(',')}`
-              );
-            }
-          }
-        }
-
-        return false;
-      })
-    );
-  }
-
-  deleteIndices({ indices, regexp, dryRun }) {
-    let deletedIndices = 0;
-    return Promise.all(
-      indices
-        .filter(({ name: indexName }) => regexp.test(indexName) === true)
-        .map(async ({ name: indexName }) => {
-          deletedIndices++;
-
-          if (dryRun === false) {
-            this.writeProgress(`Deleted indices: ${deletedIndices}`);
-            const index = this.client.initIndex(indexName);
-            const { taskID } = await this.client.deleteIndex(indexName);
-            return index.waitTask(taskID);
-          } else {
-            console.log(`[DRY RUN] Delete index ${indexName}`);
-            return false;
-          }
-        })
-    ).then(() => {
-      console.log('');
-      if (dryRun === false) {
-        console.log(`${deletedIndices} indices deleted`);
-      } else {
-        console.log(`[DRY RUN] ${deletedIndices} indices deleted`);
-      }
-    });
-  }
-
-  async deleteIndicesPattern(options) {
-    this.client = algolia(options.appId, options.apiKey);
-    const { items: indices } = await this.client.listIndexes();
-    const regexp = new RegExp(options.regexp);
-    await this.removeReplicas({ indices, regexp, dryRun: options.dryRun });
-    await this.deleteIndices({ indices, regexp, dryRun: options.dryRun });
-  }
-
-  start(program) {
-    try {
-      // Validate command; if invalid display help text and exit
-      this.validate(program, this.message, this.params);
-
-      // Config params
-      const options = {
-        appId: program.algoliaappid,
-        apiKey: program.algoliaapikey,
-        regexp: program.regexp,
-        dryRun: program.dryrun !== undefined ? program.dryrun === 'true' : true,
-      };
-
-      // Delete indices
-      return this.deleteIndicesPattern(options);
-    } catch (e) {
-      throw e;
-    }
-  }
-}
-
-module.exports = new DeleteIndicesPatternScript();

package/commands/Export.js

@@ -1,117 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const algolia = require('algoliasearch');
-const Base = require('./Base.js');
-
-class ExportScript extends Base {
-  constructor() {
-    super();
-    // Bind class methods
-    this.getOutput = this.getOutput.bind(this);
-    this.parseParams = this.parseParams.bind(this);
-    this.writeFile = this.writeFile.bind(this);
-    this.exportData = this.exportData.bind(this);
-    this.start = this.start.bind(this);
-    // Define validation constants
-    this.message =
-      '\nExample: $ algolia export -a algoliaappid -k algoliaapikey -n algoliaindexname -o outputpath -p params\n\n';
-    this.params = ['algoliaappid', 'algoliaapikey', 'algoliaindexname'];
-  }
-
-  getOutput(outputPath) {
-    // If no outputPath is provided, use directory from which command was invoked
-    const outputDir =
-      outputPath !== null ? this.normalizePath(outputPath) : process.cwd();
-    // Ensure outputPath is a directory
-    if (!fs.lstatSync(outputDir).isDirectory())
-      throw new Error('Output path must be a directory.');
-    return outputDir;
-  }
-
-  parseParams(params) {
-    try {
-      if (params === null) return { hitsPerPage: 1000 };
-      return JSON.parse(params);
-    } catch (e) {
-      throw e;
-    }
-  }
-
-  writeFile(hits, options, fileCount) {
-    const filename = `algolia-index-${options.indexName}-${fileCount}.json`;
-    const filePath = path.resolve(options.outputPath, filename);
-    fs.writeFileSync(filePath, JSON.stringify(hits));
-    return console.log(`\nDone writing ${filename}`);
-  }
-
-  exportData(options) {
-    return new Promise((resolve, reject) => {
-      // Instantiate Algolia index
-      const client = algolia(options.appId, options.apiKey);
-      const index = client.initIndex(options.indexName);
-
-      // Export index
-      const browse = index.browseAll('', options.params);
-      let hits = [];
-      let hitsCount = 0;
-      let fileCount = 0;
-
-      browse.on('result', result => {
-        // Push 1000 new hits to array
-        hits = hits.concat(result.hits);
-        hitsCount += result.hits.length;
-        this.writeProgress(`Records browsed: ${hitsCount}`);
-        if (hits.length >= 10000) {
-          // Write batch of 10,000 records to file
-          fileCount++;
-          this.writeFile(hits, options, fileCount);
-          // Clear array
-          hits = [];
-        }
-      });
-
-      browse.on('end', () => {
-        if (hits.length > 0) {
-          // Write remaining records to file
-          fileCount++;
-          this.writeFile(hits, options, fileCount);
-        }
-        return resolve(
-          `\nDone exporting index.\nSee your data here: ${options.outputPath}`
-        );
-      });
-
-      browse.on('error', err => reject(err));
-    });
-  }
-
-  async start(program) {
-    try {
-      // Validate command; if invalid display help text and exit
-      this.validate(program, this.message, this.params);
-
-      // Config params
-      const options = {
-        appId: program.algoliaappid,
-        apiKey: program.algoliaapikey,
-        indexName: program.algoliaindexname,
-        outputPath: program.outputpath || null,
-        params: program.params || null,
-      };
-
-      // Configure and validate output path
-      options.outputPath = this.getOutput(options.outputPath);
-      // Configure browseAll params
-      options.params = this.parseParams(options.params);
-
-      // Export data
-      const result = await this.exportData(options);
-      return console.log(result);
-    } catch (e) {
-      throw e;
-    }
-  }
-}
-
-const exportScript = new ExportScript();
-module.exports = exportScript;