https://github.com/eyeplum/cicero-tui
Unicode tool with a terminal user interface.
https://github.com/eyeplum/cicero-tui
cli linux macos rust tui unicode
Last synced: about 1 year ago
JSON representation
Unicode tool with a terminal user interface.
- Host: GitHub
- URL: https://github.com/eyeplum/cicero-tui
- Owner: eyeplum
- License: gpl-3.0
- Created: 2020-02-12T07:45:41.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-24T01:43:59.000Z (over 3 years ago)
- Last Synced: 2024-10-29T07:07:41.821Z (over 1 year ago)
- Topics: cli, linux, macos, rust, tui, unicode
- Language: Rust
- Homepage:
- Size: 261 KB
- Stars: 46
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# cicero [](https://github.com/eyeplum/cicero-tui/actions?query=workflow%3A%22Build+and+Test%22)
Unicode tool with a terminal user interface.
## Usage
```
$ cicero -h
Cicero: A Unicode Tool 0.2.1 (Unicode Version 13.0.0)
USAGE:
cicero.exe [FLAGS] [OPTIONS] [INPUT]
FLAGS:
-u Parses INPUT as comma separated code points,
same as '--input-type=code-points',
ignored if '--input-type' is specified
-g, --generate-flamegraph Generate Flamegraph for all Unicode Planes,
which can be loaded by Chrome's tracer UI (about:tracing)
-h, --help Prints help information
-t, --tui Shows Terminal UI
-V, --version Prints version information
OPTIONS:
-i, --input-type Specifies input type, 'string' by default,
valid values: string, code-points
-o, --output-format Specifies output format, 'text' by default,
valid values: text, json
ARGS:
a string or comma separated code points
```
## Supported Platforms
Cicero is tested on GNU/Linux, macOS, and Windows.
## Installation
### Homebrew Tap
The easiest way to install Cicero is via homebrew tap.
```sh
$ brew install eyeplum/tap/cicero-tui
```
Or alternatively:
```sh
$ brew tap eyeplum/tap
$ brew install cicero-tui
```
### AUR
`cicero` can be installed from available [AUR packages](https://aur.archlinux.org/packages/?O=0&SeB=b&K=cicero&outdated=&SB=n&SO=a&PP=50&do_Search=Go) using an [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers). For example,
```sh
$ yay -S cicero
```
If you prefer, you can clone the [AUR packages](https://aur.archlinux.org/packages/?O=0&SeB=b&K=cicero&outdated=&SB=n&SO=a&PP=50&do_Search=Go) and then compile them with [makepkg](https://wiki.archlinux.org/index.php/Makepkg). For example,
```sh
$ git clone https://aur.archlinux.org/cicero.git
$ cd cicero
$ makepkg -si
```
### Building From Source
You can also build Cicero from source.
#### Rust
Make sure the latest stable Rust toolchain is installed. See [rustup](https://rustup.rs/).
#### fontconfig and freetype (macOS and Linux only)
Cicero requires `fontconfig` and `freetype` libraries to build on Unix platforms.
- On GNU/Linux (Tested on Ubuntu 18.04 LTS)
```sh
# Assuming a C/C++ compiler and CMake are installed
# This installs shared libraries for both fontconfig and freetype
$ sudo apt install libfontconfig1-dev
```
- On macOS
```sh
# Assuming homebrew is installed
$ brew install pkg-config fontconfig
```
#### Building
Building cicero should be as easy as:
```sh
$ git clone https://github.com/eyeplum/cicero-tui
$ cd cicero-tui
$ cargo build --release
$ ./target/release/cicero --version
Cicero: A Unicode Tool 0.1.0 (Unicode Version 13.0.0)
```
You could also copy the final product to somewhere in your `PATH`, for example:
```sh
$ cp target/release/cicero $HOME/.local/bin/
```
## Configuration
A `settings.toml` file can be created to configure character previews of Cicero.
**Note: The configuration file is required on Windows in order to preview characters.**
The file is read from the following locations:
- On Unix platforms, the file is read from `$HOME/.config/cicero/settings.toml`
- On Windows, the file is read from `C:\Users\\.config\cicero\settings.toml`
The configuration file has the following format:
```toml
# Whether to use fontconfig for font discovery.
# True by default.
# Ignored on Windows (as fontconfig is only available on Unix platforms).
use_fontconfig = false
# Paths for recursively searching for fonts.
# Required on Windows in order to preview characters.
# Must be absolute paths.
# Ignored if fontconfig is set to true.
font_search_paths = [""]
# Preview fonts configuration.
# Optional. If omitted all discovered fonts are used in character preview.
# Multiple entries can be defined, the final fonts used in character preview
# are a union of all fonts matched by all entries.
[[preview_fonts]]
code_point_range = "" # Code point range to apply this entry, supported formats:
# - An inclusive range of Unicode Code Points, e.g. "U+0020..U+00FF"
# - Unicode Block name, e.g. "Basic Latin"
# - Unicode Plane name, e.g. "Basic Multilingual Plane"
# This filed is optional, if omitted this entry will be applied
# to all Unicode characters.
font_name = "" # Name of the font to be added to the preview list.
# The name is partially matched to the font's family name and full name.
```
### `settings.toml` Examples
#### Unix
##### Use `fontconfig`
This config file has the following behaviors:
- Use `fontconfig` for font discovery
- Use `Noto Sans` for displayable ASCII characters
- Use all fonts with `CJK` in their name for characters in the `CJK Unified Ideographs` block
- Use all discovered fonts for other characters
```toml
[[preview_fonts]]
code_point_range = "U+0020..U+007E"
font_name = "Noto Sans"
[[preview_fonts]]
code_point_range = "CJK Unified Ideographs"
font_name = "CJK"
```
##### Don't use `fontconfig`
This config file has the following behaviours:
- Don't use `fontconfig` for font discovery
- Search fonts recursively in `~/Fonts/` and `~/Documents/Fonts/` directory
- Use `Noto Sans` for displayable ASCII characters
- Use all fonts with `CJK` in their name for characters in the `CJK Unified Ideographs` block
- Use all discovered fonts for other characters
```toml
use_fontconfig = false
font_search_paths = [
"/home//Fonts",
"/home//Documents/Fonts"
]
[[preview_fonts]]
code_point_range = "U+0020..U+007E"
font_name = "Noto Sans"
[[preview_fonts]]
code_point_range = "CJK Unified Ideographs"
font_name = "CJK"
```
#### Windows
- Search fonts recursively in `C:\Windows\Fonts` and `C:\Users\\Documents\Fonts` directory
- Use `Noto Sans` for displayable ASCII characters
- Use all fonts with `CJK` in their name for characters in the `CJK Unified Ideographs` block
- Use all discovered fonts for other characters
```toml
font_search_paths = [
"C:\\Windows\\Fonts",
"C:\\Users\\\\Documents\\Fonts",
]
[[preview_fonts]]
code_point_range = "U+0020..U+007E"
font_name = "Noto Sans"
[[preview_fonts]]
code_point_range = "CJK Unified Ideographs"
font_name = "CJK"
```
## License
[](https://www.gnu.org/licenses/gpl-3.0.html)