actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
60 lines (48 loc) • 2.8 kB
Plain Text
actionhero - a node.js API framework for both tcp sockets, web sockets, and http clients.
Binary options:
* help (default)
* start
* startCluster
* generate
* generateAction
* generateTask
* generateInitializer
* generateServer
Descriptions:
* actionhero help
will display this document
* actionhero generate
will prepare an empty directory with a template actionhero project
* actionhero generateAction --name=[name] --description=[description] --inputsRequired=[inputsRequired] --inputsOptional=[inputsOptional]
will generate a new action in "actions"
[] (required)
[] (required) should be wrapped in quotes if it contains spaces
* actionhero generateTask --name=[name] --description=[description] --scope=[scope] --frequency=[frequency]
will generate a new task in "tasks"
[] (required)
[] (required) should be wrapped in quotes if it contains spaces
[] (optional) can be "any" or "all"
[] (optional)
* actionhero generateInitializer --name=[name]
will generate a new initializer in "initializers"
[] (required)
* actionhero generateServer --name=[name]
will generate a new server in "servers"
[] (required)
* actionhero start --config=[/path/to/config.js] --title=[processTitle] --daemon
will start a template actionhero server
this is the respondent to "npm start"
[] (optional) path to config.js, defaults to "process.cwd() + '/' + config.js". You can also use ENV[ACTIONHERO_CONFIG].
[] (optional) process title to use for actionhero-s ID, ps, log, and pidFile defaults. Must be unique for each member of the cluster. You can also use ENV[ACTIONHERO_TITLE]. Process renaming does not work on OSX/Windows
[] (optional) to fork and run as a new background process defaults to false
* actionhero startCluster --exec=[command] --workers=[numWorkers] --pidfile=[path] --log=[path] --title=[clusterTitle] --workerTitlePrefix=[prefix] --config=[/path/to/config.js] --daemon
will launch a actionhero cluster (using node-s cluster module)
[exec] (optional) command for the cluster-master to run to stat the workers
[workers] (optional) number of workers (defaults to # CPUs - 2)
[pidfile] (optional) pidfile location (defaults to process.cwd() + '/pids')
[log] (optional) logfile (defaults to process.cwd() + /log/cluster.log)
[title] (optional) default actionhero-master Does not work on OSX/Windows
[workerTitlePrefix] (optional) default actionhero-worker
[config] (optional) path to config.js for workers, defaults to "process.cwd() + '/' + config.js". You can also use ENV[ACTIONHERO_CONFIG]
[daemon] (optional) to fork and run as a new background process defaults to false
More Help & the actionhero documentation can be found @ http://actionherojs.com