Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove padding from descriptions #608

Closed
wants to merge 1 commit into from
Closed

Conversation

rlidwka
Copy link
Collaborator

@rlidwka rlidwka commented Aug 1, 2014

With this and tj/commander.js#237 patch --help output would look like this:

$ ./pm2

  Usage: pm2 [cmd] app

  Commands:

    start [options] <file|json|stdin>                  start and daemonize an app
    deploy <file|environment>                          deploy your json
    startOrRestart <json>                              start or restart JSON file
    stop [options] <id|name|all|json|stdin>            stop a process (to start it again, do pm2 restart <app>)
    restart [options] <id|name|all|json|stdin>         restart a process
    reload <name|all>                                  reload processes (note that its for app using HTTP/HTTPS)
    gracefulReload <name|all>                          gracefully reload a process. Send a "shutdown" message to close all connections.
    delete <name|id|script|all|json|stdin>             stop and delete a process from pm2 process list
    sendSignal <signal> <pm2_id|name>                  send a system signal to the target process
    ping                                               ping pm2 daemon - if not up it will launch it
    updatePM2                                          updatePM2 after a npm update
    interact [secret_key] [public_key] [machine_name]  launch agent to interact with Keymetrics
    killInteract                                       stop agent
    infoInteract                                       get information about agent
    web                                                launch an health API on port 9615
    dump                                               dump all processes for resurrecting them later
    save                                               (alias) dump all processes for resurrecting them later
    resurrect                                          resurrect previously dumped processes
    startup <platform>                                 auto resurect process at startup. [platform] = ubuntu, centos, gentoo or systemd
    generate                                           generate an ecosystem.json configuration file
    ecosystem                                          generate an ecosystem.json configuration file
    describe <id>                                      describe all parameters of a process id
    desc <id>                                          describe all parameters of a process id
    list                                               list all processes
    ls                                                 (alias) list all processes
    l                                                  (alias) list all processes
    status                                             (alias) list all processes
    jlist                                              list all processes in JSON format
    prettylist                                         print json in a prettified JSON
    monit                                              launch termcaps monitoring
    m                                                  (alias) launch termcaps monitoring
    flush                                              flush logs
    reloadLogs                                         reload all logs
    logs [id|name]                                     stream logs file. Default stream all logs
    ilogs                                              advanced interface to display logs
    kill                                               kill daemon
    *                                                  undefined

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -v --version                         get version
    -s --silent                          hide all messages
    -m --mini-list                       display a compacted list without formatting
    -f --force                           force actions
    -n --name <name>                     set a <name> for script
    -i --instances <number>              launch [number] instances (for networked app)(load balanced)
    -o --output <path>                   specify out log file
    -e --error <path>                    specify error log file
    -p --pid <pid>                       specify pid file
    --env <environment_name>             specify environment to get specific env variables (for JSON declaration)
    -x --execute-command                 execute a program using fork system
    -u --user <username>                 define user when generating startup script
    -c --cron <cron_pattern>             restart a running process based on a cron pattern
    -w --write                           write configuration in local folder
    --interpreter <interpreter>          the interpreter pm2 should use for executing app (bash, python...)
    --log-date-format <momentjs format>  add custom prefix timestamp to logs
    --no-daemon                          run pm2 daemon in the foreground if it doesn't exist already
    --merge-logs                         merge logs from different instances but keep error and out separated
    --watch                              watch application folder for changes
    --node-args <node_args>              space delimited arguments to pass to node in cluster mode - e.g. --node-args="--debug=7001 --trace-deprecation"
    --run-as-user <run_as_user>          The user or uid to run a managed process as
    --run-as-group <run_as_group>        The group or gid to run a managed process as
    --no-color                           skip colors

  Basic Examples:

    Start an app using all CPUs available + set a name :
    $ pm2 start app.js -i max --name "api"

    Restart the previous app launched, by name :
    $ pm2 restart api

    Stop the app :
    $ pm2 stop api

    Restart the app that is stopped :
    $ pm2 restart api

    Remove the app from the process list :
    $ pm2 delete api

    Kill daemon pm2 :
    $ pm2 kill

    Update pm2 :
    $ npm install pm2@latest -g ; pm2 updatePM2

    More examples in https://github.com/Unitech/pm2#usagefeatures

  Deployment help:

    $ pm2 deploy help

@soyuka
Copy link
Collaborator

soyuka commented Aug 11, 2014

Waiting for commander to be published and it's good to go.

@Unitech
Copy link
Owner

Unitech commented Oct 28, 2014

the commander dependency has been updated, it looks good now (:

@Unitech Unitech closed this Oct 28, 2014
@soyuka
Copy link
Collaborator

soyuka commented Oct 28, 2014

👍 thanks @rlidwka

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants