1  # ansito
 2  
 3  [![ci](https://github.com/pawamoy/ansito/workflows/ci/badge.svg)](https://github.com/pawamoy/ansito/actions?query=workflow%3Aci)
 4  [![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://pawamoy.github.io/ansito/)
 5  [![pypi version](https://img.shields.io/pypi/v/ansito.svg)](https://pypi.org/project/ansito/)
 6  [![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/ansito)
 7  [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#ansito:gitter.im)
 8  
 9  Translate ANSI codes to any other format.
10  
11  Currently, only Conky format is supported.
12  
13  **:warning: This project is unmaintained.
14  Drop me a message if you would like me to transfer it to you
15  or add you as a collaborator.**
16  
17  ## Installation
18  
19  With `pip`:
20  
21  ```bash
22  pip install ansito
23  ```
24  
25  With [`pipx`](https://github.com/pipxproject/pipx):
26  
27  ```bash
28  python3.8 -m pip install --user pipx
29  pipx install ansito
30  ```
31  
32  ## Usage (command-line)
33  
34  ```
35  usage: ansito [-h] FILENAME
36  
37  positional arguments:
38    FILENAME    File to translate, or - for stdin.
39  
40  optional arguments:
41    -h, --help  show this help message and exit
42  
43  ```
44  
45  Example:
46  
47  ```bash
48  command-that-output-colors | ansito -
49  ```
50  
51  Real-word example with `taskwarrior` in a Conky configuration file:
52  
53  ```lua
54  ${texecpi 60 flock ~/.task task limit:10 rc.defaultwidth:80 rc._forcecolor:on rc.verbose:affected,blank list | ansito - | sed -r 's/([^ ])#/\1\\#/g'
55  ```
56  
57  :warning: **Conky does not have "background colors" for text,
58  so ansito will not be able to convert the ANSI codes for background colors
59  to Conky colors!**