omelot-cli/dist/lib/consts.js

omelot command line client for managing omelot

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.consts = {
    CONSOLE_MODULE: '__console__',
    PROMPT: '@omelot : ',
    WELCOME_INFO: ['\nWelcome to Omelot interactive client.',
        'Omelot is a fast, scalable game server framework for node.js. ',
        'Type \\\'help\\\' for more information.\n'
    ],
    HELP_INFO_1: [
        '\nFor information about Omelot products and services, visit:',
        '   https://omelot.io/',
        '\nList of all Omelot commands:\n'
    ],
    HELP_INFO_2: [
        '\nFor more command usage, type : help command',
        'example: help show\n'
    ],
    HELP_LOGIN: [
        '\nWelcome to Omelot interactive client.',
        'Omelot is a fast, scalable game server framework for node.js. ',
        'You can use following command to connect to omelot master',
        'omelot-cli -h host -P port -u user -p password',
        'Default type omelot-cli equals to:',
        'omelot-cli -h 127.0.0.1 -P 3005 -u admin -p admin\n'
    ],
    COMANDS_ALL: [
        ['command', '  description'],
        ['?', '  symbol for help'],
        ['help', '  display the help'],
        ['quit', '  quit omelot-cli'],
        ['kill', '  kill all servers'],
        ['exec', '  exec script files'],
        ['get', '  equal to app.get(key) '],
        ['set', '  equal to app.set(key, value)'],
        ['add', '  add server to omelot clusters'],
        ['stop', '  stop server. Takes serverId as argument'],
        ['show', '  show infos like : user, servers, connections'],
        ['use', '  use another server. Takes serverId as argument'],
        ['enable', '  enable an admin console module or enable app settings'],
        ['disable', '  disable an admin console module or disable app settings'],
        ['dump', '  make a dump of the V8 heap and cpu for later inspection'],
        ['addCron', '  add cron for server'],
        ['removeCron', '  remove cron for server'],
        ['blacklist', ' add blacklist for frontend server'],
        ['run', ' run script in server']
    ],
    COMANDS_MAP: {
        'help': 1,
        'add': ['\nadd server to omelot clusters',
            'add args are key=value from servers.json config files',
            'example: add host=127.0.0.1 port=3451 serverType=chat id=chat-server-2',
            'example: add host=127.0.0.1 port=3152 serverType=connector id=connector-server-3 clientPort=3012 frontend=true\n',
        ],
        'show': ['\nshow infos like : servers, connections',
            'you can show following informations:',
            'servers, connections, logins, modules, status, proxy, handler, components, settings',
            'example: show servers',
            'example: show connections',
            'example: show proxy',
            'example: show handler',
            'example: show logins\n'
        ],
        'config': ['\nconfig infos like : proxy, remote, connection, connector, session',
            'you can show following informations:',
            'proxy, remote, connection, connector, session, protobuf',
            'localSession, channel, server, scheduler, globalChannel, monitor',
            'example: show config proxy',
            'example: show config remote',
            'example: show config connection',
            'note: show config xxx command show configuration from app.get(\\\'xxxConfig\\\')',
            'in omelot you can pass opt config to component to make your like-style server',
            'but you should keep in mind to use it in a proper context\n'
        ],
        'use': ['\nuse another server. takes serverId|all as argument',
            'use <serverId>|all',
            'then you will switch to serverId|all context',
            'your command will be applied to serverId|all server',
            'example: use area-server-1',
            'example: use all\n'
        ],
        'enable': ['\nenable an admin console module or enable app settings',
            'enable module <moduleId>',
            'enable app <settings>',
            'example: enable module systemInfo',
            'example: enable app systemMonitor\n',
        ],
        'disable': ['\ndisable an admin console module or disable app settings',
            'disable module <moduleId>',
            'disable app <settings>',
            'example: disable module systemInfo',
            'example: disable app systemMonitor\n'
        ],
        'stop': ['\nstop server. takes serverId as argument.',
            'stop <serverId>',
            'example: stop area-server-1\n'
        ],
        'kill': ['\nkill all servers.',
            'example: kill',
            'note: be carefull to use this command\n'
        ],
        'dump': ['\nmake a dump of the V8 heap and cpu for later inspection',
            'dump cpu|memory <filepath> [times] [--force]',
            'times is the number of cpu dump costs in seconds',
            'example: dump cpu /home/xxx/test 5',
            'example: dump memory /home/xxx/test',
            'note: you can add --force to write dump file if file existed',
            'example: dump cpu /home/xxx/test 5 --force',
            'example: dump memory /home/xxx/test --force\n'
        ],
        'get': ['\nequal to app.get(key)',
            'example: get <key>\n'
        ],
        'set': ['\nequal to app.set(key, value)',
            'example: set <key> <value>',
            'note: value must be string\n'
        ],
        'exec': ['\nexec script files',
            'example: exec <filepath>',
            'filepath can be relative path to your omelot-cli pwd path',
            'example : exec xxx.js',
            'equals to : exec pwd/xxx.js',
            'filepath also can be absolute with \\\' / \\\' ahead',
            'example : exec /home/user/xxx.js\n'
        ],
        'addCron': ['\nadd cron for server',
            'addCron args are key=value from crons.json config files',
            'example: addCron id=8 serverId=chat-server-1 \'time=0 30 10 * * *\' action=chatCron.send',
            'example: addCron id=8 serverType=chat \'time=0 30 10 * * *\' action=chatCron.send\n'
        ],
        'removeCron': ['\nremove cron for server',
            'example: removeCron id=8 serverId=chat-server-1',
            'example: removeCron id=8 serverType=chat'
        ],
        'blacklist': ['\nadd blacklist for frontend server',
            'example: blacklist 192.168.10.120 192.168.18.60',
            'example: blacklist \b(([01]?\d?\d|2[0-4]\d|25[0-5])\.){3}([01]?\d?\d|2[0-4]\d|25[0-5])\b'
        ],
        'run': ['\nrun script in server',
            'example: run app.get("sessionService").getSessionsCount()',
            'example: run app.isMaster()'
        ]
    },
    COMANDS_COMPLETE_INFO: {
        'help': 1,
        'add': 1,
        'show': 1,
        'enable': 1,
        'disable': 1,
        'stop': 1,
        'kill': 1,
        'get': 1,
        'set': 1,
        'use': 1,
        'dump': 1,
        'exec': 1,
        'addCron': 1,
        'removeCron': 1,
        'blacklist': 1,
        'run': 1
    },
    SHOW_COMMAND: {
        'servers': 1,
        'connections': 1,
        'logins': 1,
        'modules': 1,
        'status': 1,
        'config': 1,
        'proxy': 1,
        'handler': 1,
        'components': 1,
        'settings': 1
    },
    CONTEXT_COMMAND: {
        'status': 1,
        'logins': 1,
        'proxy': 1,
        'handler': 1,
        'components': 1,
        'settings': 1,
        'enable': 1,
        'disable': 1
    },
    COMPLETE_TWO: {
        'show': 1,
        'help': 1,
        'enable': 1,
        'disable': 1,
        'dump': 1
    },
    // ASCII_LOGO: [
    //     ".______     ______   .___  ___.  _______   __         ______   ",
    //     "|   _  )   (  __  )  |   \\/   | |   ____| |  |       (  __  )  ",
    //     "|  |_)  ) |  |  |  | |  \\  /  | |  |__    |  |      |  |  |  | ",
    //     "|   ___)  |  |  |  | |   \\/   | |   __|   |  |      |  |  |  | ",
    //     "|  |      |  `--'  | |  |  |  | |  |____  |  `----. |  `--'  | ",
    //     "| _|       (______)  |__|  |__| |_______| |_______|  (______)  "
    // ],
    ASCII_LOGO: [
        '.__________________.',
        '|                  |',
        '|      OMELOT       |',
        '|__________________|',
    ],
    COMANDS_COMPLETE: ['help', 'quit', 'kill', 'exec', 'get', 'set',
        'add', 'stop', 'show', 'use', 'enable', 'disable', 'dump', 'addCron', 'removeCron'],
    COMANDS_ERROR: 'this command is error format',
    COMANDS_ADD_ERROR: '\nadd command error\n',
    COMANDS_ENABLE_ERROR: '\nenable command error\n',
    COMANDS_DISABLE_ERROR: '\ndisable command error\n',
    COMANDS_CONFIG_ERROR: '\nconfig command error\n',
    COMANDS_SHOW_ERROR: '\nshow command error\n',
    COMANDS_KILL_ERROR: '\nkill command error\n',
    COMANDS_USE_ERROR: '\nuse command error\n',
    COMANDS_STOP_ERROR: '\nstop command error\n',
    COMANDS_EXEC_ERROR: '\nexec command script filepath error\n',
    COMANDS_CONTEXT_ERROR: 'this command is not used in this context\nyou can use command \\\'use\\\' to switch context',
    MODULE_INFO: 'there are following modules registered in omelot clusters',
    COMPONENTS_INFO: 'there are following components registered in current server',
    STATUS_ERROR: 'can not get status in this server',
    KILL_QUESTION_INFO: 'warning : do you really want to kill all servers [yes/no] ',
    STOP_QUESTION_INFO: 'warning : do you really want to stop this server [yes/no] ',
    ADD_QUESTION_INFO: 'warning : do you really want to add this server [yes/no] ',
    ADDCRON_QUESTION_INFO: 'warning : do you really want to add this cron [yes/no] ',
    BLACKLIST_QUESTION_INFO: 'warning : do you really want to add this blacklist [yes/no] ',
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vbGliL2NvbnN0cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFXLFFBQUEsTUFBTSxHQUFHO0lBQ2hCLGNBQWMsRUFBRSxhQUFhO0lBRTdCLE1BQU0sRUFBRSxZQUFZO0lBRXBCLFlBQVksRUFBRSxDQUFDLHlDQUF5QztRQUNwRCxnRUFBZ0U7UUFDaEUsMkNBQTJDO0tBQzlDO0lBRUQsV0FBVyxFQUFFO1FBQ1QsOERBQThEO1FBQzlELHVCQUF1QjtRQUN2QixrQ0FBa0M7S0FDckM7SUFFRCxXQUFXLEVBQUU7UUFDVCwrQ0FBK0M7UUFDL0Msc0JBQXNCO0tBQ3pCO0lBRUQsVUFBVSxFQUFFO1FBQ1IseUNBQXlDO1FBQ3pDLGdFQUFnRTtRQUNoRSwyREFBMkQ7UUFDM0QsZ0RBQWdEO1FBQ2hELG9DQUFvQztRQUNwQyxxREFBcUQ7S0FDeEQ7SUFFRCxXQUFXLEVBQUU7UUFDVCxDQUFDLFNBQVMsRUFBRSxlQUFlLENBQUM7UUFDNUIsQ0FBQyxHQUFHLEVBQUUsbUJBQW1CLENBQUM7UUFDMUIsQ0FBQyxNQUFNLEVBQUUsb0JBQW9CLENBQUM7UUFDOUIsQ0FBQyxNQUFNLEVBQUUsbUJBQW1CLENBQUM7UUFDN0IsQ0FBQyxNQUFNLEVBQUUsb0JBQW9CLENBQUM7UUFDOUIsQ0FBQyxNQUFNLEVBQUUscUJBQXFCLENBQUM7UUFDL0IsQ0FBQyxLQUFLLEVBQUUsMEJBQTBCLENBQUM7UUFDbkMsQ0FBQyxLQUFLLEVBQUUsZ0NBQWdDLENBQUM7UUFDekMsQ0FBQyxLQUFLLEVBQUUsaUNBQWlDLENBQUM7UUFDMUMsQ0FBQyxNQUFNLEVBQUUsMkNBQTJDLENBQUM7UUFDckQsQ0FBQyxNQUFNLEVBQUUsZ0RBQWdELENBQUM7UUFDMUQsQ0FBQyxLQUFLLEVBQUUsa0RBQWtELENBQUM7UUFDM0QsQ0FBQyxRQUFRLEVBQUUseURBQXlELENBQUM7UUFDckUsQ0FBQyxTQUFTLEVBQUUsMkRBQTJELENBQUM7UUFDeEUsQ0FBQyxNQUFNLEVBQUUsMkRBQTJELENBQUM7UUFDckUsQ0FBQyxTQUFTLEVBQUUsdUJBQXVCLENBQUM7UUFDcEMsQ0FBQyxZQUFZLEVBQUUsMEJBQTBCLENBQUM7UUFDMUMsQ0FBQyxXQUFXLEVBQUUsb0NBQW9DLENBQUM7UUFDbkQsQ0FBQyxLQUFLLEVBQUUsdUJBQXVCLENBQUM7S0FDbkM7SUFFRCxXQUFXLEVBQUU7UUFDVCxNQUFNLEVBQUUsQ0FBQztRQUNULEtBQUssRUFBRSxDQUFDLGlDQUFpQztZQUNyQyx1REFBdUQ7WUFDdkQsd0VBQXdFO1lBQ3hFLGtIQUFrSDtTQUNySDtRQUNELE1BQU0sRUFBRSxDQUFDLDBDQUEwQztZQUMvQyxzQ0FBc0M7WUFDdEMscUZBQXFGO1lBQ3JGLHVCQUF1QjtZQUN2QiwyQkFBMkI7WUFDM0IscUJBQXFCO1lBQ3JCLHVCQUF1QjtZQUN2Qix3QkFBd0I7U0FDM0I7UUFDRCxRQUFRLEVBQUUsQ0FBQyxxRUFBcUU7WUFDNUUsc0NBQXNDO1lBQ3RDLHlEQUF5RDtZQUN6RCxrRUFBa0U7WUFDbEUsNEJBQTRCO1lBQzVCLDZCQUE2QjtZQUM3QixpQ0FBaUM7WUFDakMsa0ZBQWtGO1lBQ2xGLCtFQUErRTtZQUMvRSw2REFBNkQ7U0FDaEU7UUFDRCxLQUFLLEVBQUUsQ0FBQyxzREFBc0Q7WUFDMUQsb0JBQW9CO1lBQ3BCLDhDQUE4QztZQUM5QyxxREFBcUQ7WUFDckQsNEJBQTRCO1lBQzVCLG9CQUFvQjtTQUN2QjtRQUNELFFBQVEsRUFBRSxDQUFDLHlEQUF5RDtZQUNoRSwwQkFBMEI7WUFDMUIsdUJBQXVCO1lBQ3ZCLG1DQUFtQztZQUNuQyxxQ0FBcUM7U0FDeEM7UUFDRCxTQUFTLEVBQUUsQ0FBQywyREFBMkQ7WUFDbkUsMkJBQTJCO1lBQzNCLHdCQUF3QjtZQUN4QixvQ0FBb0M7WUFDcEMsc0NBQXNDO1NBQ3pDO1FBQ0QsTUFBTSxFQUFFLENBQUMsNENBQTRDO1lBQ2pELGlCQUFpQjtZQUNqQiwrQkFBK0I7U0FDbEM7UUFDRCxNQUFNLEVBQUUsQ0FBQyxxQkFBcUI7WUFDMUIsZUFBZTtZQUNmLHlDQUF5QztTQUM1QztRQUNELE1BQU0sRUFBRSxDQUFDLDJEQUEyRDtZQUNoRSw4Q0FBOEM7WUFDOUMsa0RBQWtEO1lBQ2xELG9DQUFvQztZQUNwQyxxQ0FBcUM7WUFDckMsOERBQThEO1lBQzlELDRDQUE0QztZQUM1QywrQ0FBK0M7U0FDbEQ7UUFDRCxLQUFLLEVBQUUsQ0FBQyx5QkFBeUI7WUFDN0Isc0JBQXNCO1NBQ3pCO1FBQ0QsS0FBSyxFQUFFLENBQUMsZ0NBQWdDO1lBQ3BDLDRCQUE0QjtZQUM1Qiw4QkFBOEI7U0FDakM7UUFDRCxNQUFNLEVBQUUsQ0FBQyxxQkFBcUI7WUFDMUIsMEJBQTBCO1lBQzFCLDJEQUEyRDtZQUMzRCx1QkFBdUI7WUFDdkIsNkJBQTZCO1lBQzdCLHNEQUFzRDtZQUN0RCxvQ0FBb0M7U0FDdkM7UUFDRCxTQUFTLEVBQUUsQ0FBQyx1QkFBdUI7WUFDL0IseURBQXlEO1lBQ3pELDBGQUEwRjtZQUMxRixxRkFBcUY7U0FDeEY7UUFDRCxZQUFZLEVBQUUsQ0FBQywwQkFBMEI7WUFDckMsaURBQWlEO1lBQ2pELDBDQUEwQztTQUM3QztRQUNELFdBQVcsRUFBRSxDQUFDLHFDQUFxQztZQUMvQyxpREFBaUQ7WUFDakQsMEZBQTBGO1NBQzdGO1FBQ0QsS0FBSyxFQUFFLENBQUMsd0JBQXdCO1lBQzVCLDJEQUEyRDtZQUMzRCw2QkFBNkI7U0FDaEM7S0FDSjtJQUVELHFCQUFxQixFQUFFO1FBQ25CLE1BQU0sRUFBRSxDQUFDO1FBQ1QsS0FBSyxFQUFFLENBQUM7UUFDUixNQUFNLEVBQUUsQ0FBQztRQUNULFFBQVEsRUFBRSxDQUFDO1FBQ1gsU0FBUyxFQUFFLENBQUM7UUFDWixNQUFNLEVBQUUsQ0FBQztRQUNULE1BQU0sRUFBRSxDQUFDO1FBQ1QsS0FBSyxFQUFFLENBQUM7UUFDUixLQUFLLEVBQUUsQ0FBQztRQUNSLEtBQUssRUFBRSxDQUFDO1FBQ1IsTUFBTSxFQUFFLENBQUM7UUFDVCxNQUFNLEVBQUUsQ0FBQztRQUNULFNBQVMsRUFBRSxDQUFDO1FBQ1osWUFBWSxFQUFFLENBQUM7UUFDZixXQUFXLEVBQUUsQ0FBQztRQUNkLEtBQUssRUFBRSxDQUFDO0tBQ1g7SUFFRCxZQUFZLEVBQUU7UUFDVixTQUFTLEVBQUUsQ0FBQztRQUNaLGFBQWEsRUFBRSxDQUFDO1FBQ2hCLFFBQVEsRUFBRSxDQUFDO1FBQ1gsU0FBUyxFQUFFLENBQUM7UUFDWixRQUFRLEVBQUUsQ0FBQztRQUNYLFFBQVEsRUFBRSxDQUFDO1FBQ1gsT0FBTyxFQUFFLENBQUM7UUFDVixTQUFTLEVBQUUsQ0FBQztRQUNaLFlBQVksRUFBRSxDQUFDO1FBQ2YsVUFBVSxFQUFFLENBQUM7S0FDaEI7SUFFRCxlQUFlLEVBQUU7UUFDYixRQUFRLEVBQUUsQ0FBQztRQUNYLFFBQVEsRUFBRSxDQUFDO1FBQ1gsT0FBTyxFQUFFLENBQUM7UUFDVixTQUFTLEVBQUUsQ0FBQztRQUNaLFlBQVksRUFBRSxDQUFDO1FBQ2YsVUFBVSxFQUFFLENBQUM7UUFDYixRQUFRLEVBQUUsQ0FBQztRQUNYLFNBQVMsRUFBRSxDQUFDO0tBQ2Y7SUFFRCxZQUFZLEVBQUU7UUFDVixNQUFNLEVBQUUsQ0FBQztRQUNULE1BQU0sRUFBRSxDQUFDO1FBQ1QsUUFBUSxFQUFFLENBQUM7UUFDWCxTQUFTLEVBQUUsQ0FBQztRQUNaLE1BQU0sRUFBRSxDQUFDO0tBQ1o7SUFFRCxnQkFBZ0I7SUFDaEIseUVBQXlFO0lBQ3pFLDBFQUEwRTtJQUMxRSwwRUFBMEU7SUFDMUUsMEVBQTBFO0lBQzFFLHlFQUF5RTtJQUN6RSx3RUFBd0U7SUFDeEUsS0FBSztJQUVMLFVBQVUsRUFBRTtRQUNSLHNCQUFzQjtRQUN0QixzQkFBc0I7UUFDdEIsdUJBQXVCO1FBQ3ZCLHNCQUFzQjtLQUN6QjtJQUVELGdCQUFnQixFQUFFLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxLQUFLO1FBQzNELEtBQUssRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUUsU0FBUyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsWUFBWSxDQUFDO0lBRXZGLGFBQWEsRUFBRSw4QkFBOEI7SUFDN0MsaUJBQWlCLEVBQUUsdUJBQXVCO0lBQzFDLG9CQUFvQixFQUFFLDBCQUEwQjtJQUNoRCxxQkFBcUIsRUFBRSwyQkFBMkI7SUFDbEQsb0JBQW9CLEVBQUUsMEJBQTBCO0lBQ2hELGtCQUFrQixFQUFFLHdCQUF3QjtJQUM1QyxrQkFBa0IsRUFBRSx3QkFBd0I7SUFDNUMsaUJBQWlCLEVBQUUsdUJBQXVCO0lBQzFDLGtCQUFrQixFQUFFLHdCQUF3QjtJQUM1QyxrQkFBa0IsRUFBRSx3Q0FBd0M7SUFDNUQscUJBQXFCLEVBQUUsNkZBQTZGO0lBQ3BILFdBQVcsRUFBRSwyREFBMkQ7SUFDeEUsZUFBZSxFQUFFLDZEQUE2RDtJQUM5RSxZQUFZLEVBQUUsbUNBQW1DO0lBQ2pELGtCQUFrQixFQUFFLDREQUE0RDtJQUNoRixrQkFBa0IsRUFBRSw0REFBNEQ7SUFDaEYsaUJBQWlCLEVBQUUsMkRBQTJEO0lBQzlFLHFCQUFxQixFQUFFLHlEQUF5RDtJQUNoRix1QkFBdUIsRUFBRSw4REFBOEQ7Q0FDMUYsQ0FBQyJ9