Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahmutov/term-to-html
Stream terminal output with ansi codes into nicely formatted HTML
https://github.com/bahmutov/term-to-html
ansi cli html term
Last synced: about 2 months ago
JSON representation
Stream terminal output with ansi codes into nicely formatted HTML
- Host: GitHub
- URL: https://github.com/bahmutov/term-to-html
- Owner: bahmutov
- Created: 2020-02-12T01:48:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T14:54:49.000Z (over 2 years ago)
- Last Synced: 2024-09-14T05:44:30.428Z (2 months ago)
- Topics: ansi, cli, html, term
- Language: JavaScript
- Size: 1.96 MB
- Stars: 26
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# term-to-html [](https://circleci.com/gh/bahmutov/term-to-html/tree/master)
> Stream terminal output with ansi codes into nicely formatted HTML
Imagine you have terminal output, let's say from a test runner. It looks like this
You can pipe the output through `term-to-html` to create equivalent HTML file. Same output (HTML page was white background)
The output could be used to do [visual testing against CLI output](https://glebbahmutov.com/blog/visual-diffing-for-CLI-apps/)
## Use
```shell
npm i -g term-to-html
mocha spec.js --reporter spec | term-to-html > mocha.html
```
**Note:** many applications detect non-interactive terminal and turn off colors. Usually you can enable colors using an environment variable, like `FORCE_COLOR=2` in [chalk](https://github.com/chalk/chalk) library.
### Dark theme
You can output HTML page with dark background using `--theme dark` CLI argument
```shell
| term-to-html --theme dark
```
### Use as a module
```js
const termToHtml = require('term-to-html')
const html = termToHtml.strings(stringWithAnsi, termToHtml.themes.dark.name)
```
## Testing
There are [E2E tests](e2e.js) and you can observe the output by running
```shell
FORCE_COLOR=2 npx mocha spec.js --reporter spec | ./bin/term-to-html.js
```
### Small print
Author: Gleb Bahmutov <[email protected]> © 2020
- [@bahmutov](https://twitter.com/bahmutov)
- [glebbahmutov.com](https://glebbahmutov.com)
- [blog](https://glebbahmutov.com/blog)
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
[open issue](https://github.com/bahmutov/term-to-html/issues) on Github
## MIT License
Copyright (c) 2020 Gleb Bahmutov <[email protected]>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[npm-icon]: https://nodei.co/npm/term-to-html.svg?downloads=true
[npm-url]: https://npmjs.org/package/term-to-html
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/