Walmart.Pulsar

Pulsar is a text-based, dynamic dashboard that lets processes communicate their status. Jobs can be created, updated, and completed asynchronously, and update in-place. This is intended for use in Elixir applications that run as command line tools.

Installation

If available in Hex, the package can be installed by adding pulsar to your list of dependencies in mix.exs:

def deps do
  [
    {:pulsar, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/pulsar.

limitations

Pulsar doesn't know the dimensions on the screen; large numbers of jobs in a short window will not render correctly. Likewise, long lines that wrap will cause incorrect output.

Pulsar is hard-coded for for xterm; it should use the terminal capabilities database to identify what command codes generate each effect.

Pulsar doesn't have any way to prevent other output to the console; that will cause confusing output.

License

Released under the Apache Software License 2.0.