oclif.manifest.json

{
  "commands": {
    "debug": {
      "aliases": [],
      "args": {
        "...functions": {
          "name": "...functions"
        }
      },
      "description": "Starts a debug port on 1337 for the provided function",
      "examples": [
        "> <%= config.bin %> debug exampleFunction"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "debug",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "debug.js"
      ]
    },
    "deploy": {
      "aliases": [],
      "args": {
        "...functions": {
          "name": "...functions"
        }
      },
      "description": "Deploys a function or multiple functions on the LivePerson Functions platform",
      "examples": [
        "> <%= config.bin %> deploy exampleFunction",
        "> <%= config.bin %> deploy exampleFunction --yes --no-watch",
        "> <%= config.bin %> deploy exampleFunction1 exampleFunction2 -y -w"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "yes": {
          "char": "y",
          "description": "Agrees to the approval of the deployment and prevents the confirmation dialog",
          "name": "yes",
          "allowNo": false,
          "type": "boolean"
        },
        "no-watch": {
          "char": "w",
          "description": "Don't watch deployment process",
          "name": "no-watch",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "deploy",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "deploy.js"
      ]
    },
    "get": {
      "aliases": [],
      "args": {
        "...functions": {
          "name": "...functions"
        }
      },
      "description": "Get information about different domains (deployments, functions, account and events)",
      "examples": [
        "> <%= config.bin %> get account",
        "> <%= config.bin %> get functions deployments",
        "> <%= config.bin %> get functions deployments account",
        "> <%= config.bin %> get functions deployments account events"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "get",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "get.js"
      ]
    },
    "init": {
      "aliases": [],
      "args": {
        "...functionNames": {
          "name": "...functionNames"
        }
      },
      "description": "Initialize the project with the necessary data",
      "examples": [
        "> <%= config.bin %> init <functionname>",
        "> <%= config.bin %> init <functionname> <functionsname>"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show help for the init command",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "init",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "init.js"
      ]
    },
    "invoke": {
      "aliases": [],
      "args": {
        "...functionNames": {
          "name": "...functionNames"
        }
      },
      "description": "Invokes a function",
      "examples": [
        "> <%= config.bin %> invoke exampleFunction",
        "> <%= config.bin %> invoke exampleFunction --local",
        "> <%= config.bin %> invoke exampleFunction -l"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "local": {
          "char": "l",
          "description": "Invokes the function locally with the input from the config.json",
          "name": "local",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "invoke",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "invoke.js"
      ]
    },
    "login": {
      "aliases": [],
      "args": {},
      "description": "Performs the login with LiveEngage Credentials",
      "examples": [
        "> <%= config.bin %> login",
        "> <%= config.bin %> login --accountId 123456789 --username user@liveperson.com --password p4ssw0rd",
        "> <%= config.bin %> login -a 123456789 -u user@liveperson.com -p p4ssw0rd"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Shows help for the login",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "password": {
          "char": "p",
          "description": "Password",
          "name": "password",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "username": {
          "char": "u",
          "description": "Username",
          "name": "username",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "accountId": {
          "char": "a",
          "description": "AccountId",
          "name": "accountId",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "token": {
          "char": "t",
          "description": "Token for the SSO flow",
          "hidden": true,
          "name": "token",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "userId": {
          "char": "i",
          "description": "UserId for the SSO flow",
          "hidden": true,
          "name": "userId",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "login",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": true,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "login.js"
      ]
    },
    "logout": {
      "aliases": [],
      "args": {},
      "description": "Performs the logout of your account",
      "examples": [
        "> <%= config.bin %> logout",
        "> <%= config.bin %> logout --accountId 123456789",
        "> <%= config.bin %> logout --accountId 123456789 --delete",
        "> <%= config.bin %> logout -a 123456789 -d"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "accountId": {
          "char": "a",
          "description": "Account which will be logged out",
          "name": "accountId",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "delete": {
          "char": "d",
          "description": "Deletes the account credentials from the local machine",
          "name": "delete",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "logout",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": true,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "logout.js"
      ]
    },
    "logs": {
      "aliases": [],
      "args": {
        "function-name": {
          "name": "function-name"
        }
      },
      "description": "Download function logs as CSV (limited to the first 500 logs of the provided timespan)",
      "examples": [
        "> <%= config.bin %> logs exampleFunction --start=1626156400000",
        "> <%= config.bin %> logs exampleFunction --start=1626156400000 --end=1626157400000",
        "> <%= config.bin %> logs exampleFunction --start=1626156400000 --levels=Info Warn",
        "",
        "For redirecting logs to a file:",
        "logs exampleFunction --start=1626156400000 > exampleFunction.log",
        "",
        "Fetching logs via cronjob every 10 minutes (delayed by 1 minute to be sure no logs are missed) and write it to a file:",
        "MacOS:",
        "1/10 * * * * <%= config.bin %> logs exampleFunction --start=$(date -v0S -v-11M +%s000) --end=$(date -v0S -v-1M +%s000) >> exampleFunction.log"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "start": {
          "char": "s",
          "description": "start timestamp",
          "name": "start",
          "required": true,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "removeHeader": {
          "char": "r",
          "description": "Removes the header of the logs",
          "name": "removeHeader",
          "allowNo": false,
          "type": "boolean"
        },
        "end": {
          "char": "e",
          "description": "end timestamp (default current timestamp)",
          "name": "end",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "levels": {
          "char": "l",
          "description": "log-levels - for multiple levels just use levels with space separated (e.g. -l Info Warn)",
          "name": "levels",
          "hasDynamicHelp": false,
          "multiple": true,
          "options": [
            "Info",
            "Warn",
            "Error"
          ],
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "logs",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": true,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "logs.js"
      ]
    },
    "metrics": {
      "aliases": [],
      "args": {
        "function-name": {
          "default": null,
          "description": "name of lambda",
          "name": "function-name",
          "required": true
        }
      },
      "description": "Download invocation metrics",
      "examples": [
        "> <%= config.bin %> metrics exampleFunction --last=7d",
        "> <%= config.bin %> metrics exampleFunction --start=1626156400000",
        "> <%= config.bin %> metrics exampleFunction --end=1626156400000 --last=7d",
        "> <%= config.bin %> metrics exampleFunction --start=1626156400000 --end=1626157400000",
        "",
        "For redirecting metrics to a file:",
        "lpf metrics exampleFunction --start=1626156400000 --output=\"csv\" >> exampleFunction.csv",
        "",
        "The metrics are aggregated into buckets. These buckets' sizes can be chosen as 5m, 1h, 1d",
        "",
        "Fetching metrics via cronjob every 24 hours and write it to a file:",
        "MacOS:",
        "0 0 * * * <%= config.bin %> lpf metrics exampleFunction  -l=1d -o=csv >> exampleFunction.csv"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "start": {
          "char": "s",
          "description": "start timestamp",
          "exclusive": [
            "last"
          ],
          "name": "start",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "end": {
          "char": "e",
          "description": "end timestamp (defaults to current timestamp)",
          "name": "end",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "last": {
          "char": "l",
          "description": "An alternative to start flag, metrics for the period of the last x hours|days, options: xh, xd; eg. last 12h, 7d",
          "exclusive": [
            "start"
          ],
          "name": "last",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "output": {
          "char": "o",
          "description": "Optional: output formatting for file saving purposes",
          "name": "output",
          "hasDynamicHelp": false,
          "multiple": false,
          "options": [
            "csv",
            "json"
          ],
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "metrics",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": true,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "metrics.js"
      ]
    },
    "pull": {
      "aliases": [],
      "args": {
        "...functions": {
          "name": "...functions"
        }
      },
      "description": "Pull a function or multiple from the LivePerson Functions platform to the local machine",
      "examples": [
        "> <%= config.bin %> pull exampleFunction",
        "> <%= config.bin %> pull exampleFunction --yes --no-watch",
        "> <%= config.bin %> pull exampleFunction1 exampleFunction2 -y -w"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "yes": {
          "char": "y",
          "description": "Agrees to the approval of the pull command and prevents the confirmation dialog.",
          "name": "yes",
          "allowNo": false,
          "type": "boolean"
        },
        "no-watch": {
          "char": "w",
          "description": "Don't watch pull process",
          "name": "no-watch",
          "allowNo": false,
          "type": "boolean"
        },
        "all": {
          "char": "a",
          "description": "Pulls all functions from the platform",
          "name": "all",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "pull",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "pull.js"
      ]
    },
    "push": {
      "aliases": [],
      "args": {
        "...functions": {
          "name": "...functions"
        }
      },
      "description": "Push local functions to the LivePerson functions platform",
      "examples": [
        "> <%= config.bin %> push exampleFunction",
        "> <%= config.bin %> push exampleFunction --yes --no-watch",
        "> <%= config.bin %> push exampleFunction1 exampleFunction2 -y -w"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "yes": {
          "char": "y",
          "description": "Agrees to the approval of the push and prevents the confirmation dialog",
          "name": "yes",
          "allowNo": false,
          "type": "boolean"
        },
        "no-watch": {
          "char": "w",
          "description": "Don't watch push process",
          "name": "no-watch",
          "allowNo": false,
          "type": "boolean"
        },
        "all": {
          "char": "a",
          "description": "Pushes all functions",
          "name": "all",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "push",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "push.js"
      ]
    },
    "undeploy": {
      "aliases": [],
      "args": {
        "...functions": {
          "name": "...functions"
        }
      },
      "description": "Undeploys a function or multiple functions on the LivePerson Functions platform",
      "examples": [
        "> <%= config.bin %> undeploy exampleFunction",
        "> <%= config.bin %> undeploy exampleFunction --yes --no-watch",
        "> <%= config.bin %> undeploy exampleFunction1 exampleFunction2 -y -w"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show CLI help.",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "yes": {
          "char": "y",
          "description": "Agrees to the approval of the undeployment and prevents the confirmation dialog",
          "name": "yes",
          "allowNo": false,
          "type": "boolean"
        },
        "no-watch": {
          "char": "w",
          "description": "Don't watch undeployment process",
          "name": "no-watch",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "undeploy",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "undeploy.js"
      ]
    },
    "create:function": {
      "aliases": [],
      "args": {},
      "description": "Create functions locally",
      "examples": [
        "> <%= config.bin %> create:function",
        "> <%= config.bin %> create:function -n exampleFunction -d \"This is an example description\"",
        "> <%= config.bin %> create:function -n exampleFunction -e \"bot_connectors_custom_integration\""
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show help for the create command",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "name": {
          "char": "n",
          "description": "name of function, allowed characters: A-Z, 0-9, _",
          "name": "name",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "description": {
          "char": "d",
          "description": "description of function, allowed characters: A-Z, 0-9, _",
          "name": "description",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "event": {
          "char": "e",
          "description": "ID of event, use <lpf get events> for more information",
          "name": "event",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "create:function",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "create",
        "function.js"
      ]
    },
    "create": {
      "aliases": [],
      "args": {},
      "description": "Create functions locally and schedules remotely",
      "examples": [
        "> <%= config.bin %> create:function -n exampleFunction -e controllerbot_messaging_new_conversation"
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show help for the create command",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "create",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "create",
        "index.js"
      ]
    },
    "create:schedule": {
      "aliases": [],
      "args": {},
      "description": "Creates schedules on currently logged-in account",
      "examples": [
        "> <%= config.bin %> create:schedule",
        "> <%= config.bin %> create:schedule -f exampleFunction",
        "> <%= config.bin %> create:schedule -f exampleFunction -c \"* * * * *\"",
        "> <%= config.bin %> create:schedule -f exampleFunction -c \"*/3 * * 0-12 *\""
      ],
      "flags": {
        "help": {
          "char": "h",
          "description": "Show help for the create command",
          "name": "help",
          "allowNo": false,
          "type": "boolean"
        },
        "functionName": {
          "char": "f",
          "description": "name of (deployed) function which will be scheduled",
          "name": "functionName",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "cronExpression": {
          "char": "c",
          "description": "Cron Expression",
          "name": "cronExpression",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "create:schedule",
      "pluginAlias": "liveperson-functions-cli",
      "pluginName": "liveperson-functions-cli",
      "pluginType": "core",
      "strict": false,
      "parse": true,
      "parserOptions": {},
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "create",
        "schedule.js"
      ]
    }
  },
  "version": "2.0.5-beta"
}