Manage external services from within Emacs
Manage external services from within Emacs
I came up with the idea when I got to work one Monday morning and before I could start working I had to manually start ten or so services.
To get rid of this tedious work, I started working on this Emacs plugin, which provides a nice and simple GUI to manage services.
prodigyto your Cask file:
If you are on a Mac, disable nap mode for Emacs, otherwise requests will be very slow when Emacs enters nap mode:
$ defaults write org.gnu.Emacs NSAppSleepDisabled -bool YES
Start Prodigy with
M-x prodigy. You should see a list of all defined services.
Services can be defined in a few different ways. See doc-string for information about available properties to specify:
M-x describe-variable RET prodigy-services.
Properties that accepts a function as argument all get a property list as argument, for example:
(prodigy-define-service :command (lambda (&rest args) (let ((service (plist-get args :service))) ;; ... )))
You can also use the
prodigy-callbackmacro to simplify the argument handling.
(prodigy-define-service :command (prodigy-callback (service) ;; ... ))
Depending on property, the
argslist contain various properties.
Services can be defined using the function
(prodigy-define-service :prop value ...)
Services can be defined by setting the variable
(setq prodigy-services '((:prop value ...) (:prop value ...)))
In the prodigy window, you can see a process' output with the
$key. Process output buffers use the
prodigy-view-modeand do some special pre-processing to the process output. The buffer output will be tailed (à la
tail -f) if the point is at the buffer end. There are two significant variables that influence process output: -
prodigy-output-filtersis a list of filters to apply to the output (currently, the process will be ansi-colorized and
^Mliterals will be stripped). Filter functions should take a single argument, the
outputstring, and should return a string. -
prodigy-process-on-output-hookis a hook that runs on process output. Each function in the hook takes two arguments,
service(the service data structure) and
output(the service's output).
While the service output buffer is active, you can use all the interactive functions available from the main
M-x prodigybuffer under the
cprefix key. For example, to restart the service associated with the view buffer, press
Services can have any number of tags. Tags do not have to be predefined. If they are, the service will inherit all the tags properties. Tags can also have tags. A service will inherit all tags recursively.
See doc-string for information about available properties to specify:
M-x describe-variable RET prodigy-tags.
Tags can be defined using the function
(prodigy-define-tag :prop value ...)
Tags can be defined by setting the variable
(setq prodigy-tags '((:prop value ...) (:prop value ...)))
Filters is a way to show only specific services in the Prodigy buffer. For example services with specific tag or with a name matching a string.
To add a filter, use
(prodigy-add-filter :tag 'foo) (prodigy-add-filter :name "bar")
You can also set the variable
(setq prodigy-filters '((:tag foo) (:name "bar")))
Each service is associated with a status. The built in statuses are:
stopped(default) - The process is not running.
running- The process is running. If the process status is
run, this status will be used.
ready- The process is "actually" ready. This will be set when the service outputs a message that matches its
ready-messageproperty, or it can be set manually.
stopping- Set when a service is stopping.
failed- The process failed. A service has this status if:
The only way Prodigy has an idea of the service status, is to look at the process status (note the difference between service and process status). The process status is however not always a very good indication of the service "actual" status. For example, it takes about five seconds to start a Rails server, but the process status will be
runalmost instantly after started.
To improve the service status, there is a function called
prodigy-set-status, that can change the status of a service. The function takes two arguments: The
status-id. The status id has to be one of the statuses in
You can create your own status with the function
prodigy-define-status. See doc-string for information about available properties to specify:
M-x describe-variable RET prodigy-status-list.
For more information, see status example below!
This service start a Python Simple HTTP Server on port
6001. When stopping the service, the
sigkillsignal is used.
(prodigy-define-service :name "Python app" :command "python" :args '("-m" "SimpleHTTPServer" "6001") :cwd "/path/to/my/project" :tags '(work) :stop-signal 'sigkill :kill-process-buffer-on-stop t)
This service starts a Nodemon server on port
6002. The project is using NVM (Node Version Manager), so before the process starts, NVM is set up.
(prodigy-define-service :name "Node app" :command "nodemon" :cwd "/path/to/my/project" :args '("app.coffee") :port 6002 :tags '(work node) :init-async (lambda (done) (nvm-use-for "/path/to/my/project" done)))
This service starts a Sinatra server on port
6003. The project is using RVM (Ruby Version Manager), so before the process starts, RVM is set up.
(prodigy-define-service :name "Sinatra" :command "server" :cwd "/path/to/my/project" :path '("/path/to/my/project/bin") :port 6003 :tags '(work ruby) :init-async (lambda (done) (rvm-activate-ruby-for "/path/to/my/project" done)))
Prodigy also works with Foreman.
(prodigy-define-service :name "Foreman" :command "foreman" :args '("start") :cwd "/path/to/my/project")
If a service has a tag and that tag is defined (see
prodigy-define-tag), the service inherits the tag properties. The inheritance is recursive, so if any of the service tags has tags itself, the service will inherit those tag properties as well.
This is best illustrated with an example. Rails can run with many different servers. Each server indicate that it's ready with a different log message. In the example code below, a tag is defined for each server and one for Rails that inherits all those servers.
That means that a service that is tagged with
rails, will be set to ready if it uses any of the three servers. But since there is a tag for each server, a non Rails service that uses any of the servers can simply use that tag.
(prodigy-define-tag :name 'thin :ready-message "Listening on 0\\.0\\.0\\.0:[0-9]+, CTRL\\+C to stop")
(prodigy-define-tag :name 'webrick :ready-message "WEBrick::HTTPServer#start: pid=[0-9]+ port=[0-9]+")
(prodigy-define-tag :name 'mongrel :ready-message "Ctrl-C to shutdown server")
(prodigy-define-tag :name 'rails :tags '(thin mongrel webrick))
(prodigy-define-service :name "Rails Project" :command "bundle" :args '("exec" "rails" "server") :cwd "/path/to/my/project" :tags '(rails))
(prodigy-define-service :name "Thin Project" :command "bundle" :args '("exec" "thin" "start") :cwd "/path/to/my/project" :tags '(thin))
Prodigy can only look at the process status to determine the service status. To make status even more useful, you can set status manually. Prodigy provides the function
prodigy-set-statusfor this. In this example, we create a tag
railsthat will set the status to
readywhen the server is actually ready.
The services that are tagged with
railswill all inherit this.
(prodigy-define-tag :name 'rails :on-output (lambda (&rest args) (let ((output (plist-get args :output)) (service (plist-get args :service))) (when (or (s-matches? "Listening on 0\.0\.0\.0:[0-9]+, CTRL\\+C to stop" output) (s-matches? "Ctrl-C to shutdown server" output)) (prodigy-set-status service 'ready)))))
(prodigy-define-service :name "Rails" :command "bundle" :args '("exec" "rails" "server") :cwd "/path/to/my/project" :tags '(rvm rails))
(prodigy-define-service :name "Sinatra" :command "bundle" :args '("exec" "rackup") :cwd "/path/to/my/project" :tags '(rvm rails))
For some unknown reason, Jekyll fail with this error:
error: invalid byte sequence in US-ASCII. Use --trace to view backtrace
This can be solved by adding a
jekylltag, like this:
(prodigy-define-tag :name 'jekyll :env '(("LANG" "en_US.UTF-8") ("LC_ALL" "en_US.UTF-8")))
Then tag your services with the
This is a short summary of changes between versions.
prodigy-callback, allowing for some syntactic sugar using property lambdas (that take plist as argument).
:ready-messageused to set the process status to ready when matching output appears.
Contribution is much welcome!
If your contribution is a bug fix, create your topic branch from
master. If it is a new feature, check if there exists a WIP branch (
vMAJOR.MINOR-wip). If it does, use that branch, otherwise use
Install Cask if you haven't already, then:
$ cd /path/to/prodigy.el $ cask
Run all tests with: