github.com/nycdavid/zeus@v0.0.0-20201208104106-9ba439429e03/man/src/zeus.ronn (about)

     1  zeus(1) -- boot rails in under a second
     2  =======================================================
     3  
     4  ## SYNOPSIS
     5  
     6  `zeus` [--no-color] [--log FILE] [--file-change-delay TIME] [--config PATH] COMMAND [ARGS]
     7  
     8  ## DESCRIPTION
     9  
    10  Zeus makes working with large codebases much less painful.
    11  
    12  To use Zeus with Ruby on Rails 3.0+, Just run `zeus start` in your
    13  project directory. It will output a list of available commands, including
    14  tasks to spawn consoles, servers, tests, and rake tasks.
    15  
    16  See `https://github.com/burke/zeus/blob/master/docs/ruby/modifying.md`
    17  for information on modifying the boot process that Zeus uses by default
    18  and adding custom tasks.
    19  
    20  ## SLIGHTLY MORE TECHNICAL DESCRIPTION
    21  
    22  Zeus is a language-agnostic application checkpointer for non-multithreaded applications.
    23  
    24  It is primarily targeted at ruby and other dynamic languages,
    25  where application boot time can be tens of seconds, but it can be
    26  made to work for nearly any language. However, zeus does not work
    27  well with multithreaded applications. It relies heavily on `fork(2)`,
    28  which is largely incompatible with multithreaded systems.
    29  
    30  Currently only ruby is targeted, but support for other languages is planned.
    31  
    32  Zeus lets you define common tasks, and preloads all of them in the
    33  background. When you ask to run them, zeus transparently connects
    34  your terminal to the already-running process in milliseconds.
    35  
    36  This lets you, for example, run unit tests in dozens of milliseconds,
    37  rather than dozens of seconds.
    38  
    39  Zeus also monitors all files loaded by your application, and restarts
    40  parts of it when dependencies change, to keep everything up-to-date.
    41  
    42  ## WAY MORE TECHNICAL DESCRIPTION
    43  
    44  See `https://github.com/burke/zeus/blob/master/docs/overview.md`
    45  
    46  ## OPTIONS
    47  
    48  * `--no-color`:
    49    Prints all output without color
    50  
    51  * `--log` trace-log-name:
    52    Prints process tree state details to the log file specified.
    53  
    54  * `--file-change-delay` delay:
    55    Collect all file changes that happen within the specified delay time
    56    and restart processes only after this deadline expires. The argument
    57    must be parseable by time.ParseDuration. The default delay is 300ms.
    58  
    59  * `--config` path:
    60    Read from the given JSON config file. Defaults to `zeus.json`.
    61  
    62  ## BUILTIN COMMANDS
    63  
    64  * [zeus start(1)][zeus-start]:
    65    Start a zeus server in the current directory using `zeus.json`
    66  
    67  * [zeus init(1)][zeus-init]:
    68    Generate a template zeus.json
    69  
    70  * `zeus commands(1)`:
    71    List the commands defined by zeus.json