oasis/src/cli.js

"use strict";

const yargs = require("yargs");
const _ = require("lodash");

/**
 * @param {object} presets
 * @param {string} defaultConfigFile
 */
module.exports = (presets, defaultConfigFile) =>
  yargs
    .scriptName("oasis")
    .env("OASIS")
    .help("h")
    .alias("h", "help")
    .usage("Usage: $0 [options]")
    .options("open", {
      describe:
        "Automatically open app in web browser. Use --no-open to disable.",
      default: _.get(presets, "open", true),
      type: "boolean",
    })
    .options("offline", {
      describe:
        "Don't try to connect to scuttlebutt peers or pubs. This can be changed on the 'settings' page while Oasis is running.",
      default: _.get(presets, "offline", false),
      type: "boolean",
    })
    .options("host", {
      describe: "Hostname for web app to listen on",
      default: _.get(presets, "host", "localhost"),
      type: "string",
    })
    .options("allow-host", {
      describe:
        "Extra hostname to be whitelisted (useful when running behind a proxy)",
      default: _.get(presets, "allow-host", null),
      type: "string",
    })
    .options("port", {
      describe: "Port for web app to listen on",
      default: _.get(presets, "port", 3000),
      type: "number",
    })
    .options("public", {
      describe:
        "Assume Oasis is being hosted publicly, disable HTTP POST and redact messages from people who haven't given consent for public web hosting.",
      default: _.get(presets, "public", false),
      type: "boolean",
    })
    .options("debug", {
      describe: "Use verbose output for debugging",
      default: _.get(presets, "debug", false),
      type: "boolean",
    })
    .options("theme", {
      describe: "The theme to use, if a theme hasn't been set in the cookies",
      default: _.get(presets, "theme", "classic-light"),
      type: "string",
    })
    .epilog(`The defaults can be configured in ${defaultConfigFile}.`).argv;