Skip to content

Parse ANSI terminal escape codes into usable abstract representation.

License

Notifications You must be signed in to change notification settings

diskuv/ansi-parse

 
 

Repository files navigation

Ansiparse - Escape sequences to HTML

%%0.4.0%%

Ansiparse is a library for converting raw terminal output, replete with escape codes, into formatted HTML.

Ansiparse is distributed under the ISC license.

Homepage: https://github.com/diskuv/ansi-parse

Original Author: Joel Jakubovic

Maintainer: Jonah Beckford

Installation

ansi-parse can be installed with opam:

opam install ansi-parse

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online and there is a generated version in the doc directory of the distribution.

Sample programs

If you installed ansi-parse with opam sample programs are located in the directory opam config var ansi-parse:doc.

In the distribution sample programs and tests are located in the main and driver directories of the distribution. They can be built and run with:

OCAMLRUNPARAM=b dune build -p ansi-parse @runtest

The resulting binaries are:

  • _build/default/test3.exe
  • _build/default/driver/driver.exe

Local Development

Build, test and pin your locally checked out repository with:

opam install . --verbose --with-test --with-doc

Your changes, if any, must be git commit-ed for opam install to see your changes.

About

Parse ANSI terminal escape codes into usable abstract representation.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • OCaml 76.5%
  • Perl 20.5%
  • Shell 3.0%