Files
alacritty-config/README.md
2019-07-17 10:18:39 +01:00

64 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# alacritty-config
A simple Python script to simplify configuring my alacritty. Also comes with a GUI.
## Installation
You can install `alacritty-config` by cloning this repository and running `make
install`. By default, it will be installed in `/usr/local/bin`, but you can set a
different `INSTALL_DIR` if you like. If you want the GUI as well, run `make gui`.
Uninstall it using `make uninstall`.
## Usage
Depending on your sensibilities, you might want to configure your terminal using the
[CLI](#cli) or the [GUI](#gui).
### CLI
`alacritty-config` has three different modes: show, add, and delete.
Calling the program without any arguments will dump your entire config: youre in show
mode, but you havent selected anything. If you want to know the value of the `tabspaces`
property, call `alacritty-config` with just that argument. If you want to know the action
of your third key binding, call it with `key_bindings.2.action`—were 0-indexed.
```
$ alacritty-config
<your entire config>
$ alacritty-config tabspaces
8 # or whatever you set it to
$ alacritty-config key_bindings.2.action
Paste # or whatever you set it to
```
If you want to delete a property, simply add `delete`.
```
$ alacritty-config tabspaces delete
# Poof! Its gone!
```
If you want to add or edit a property, simply add a different YAML-parseable property.
If you want to set something to `delete`, simply quote it.
```
$ alacritty-config tabspaces 4
# Set tabspaces to 4
$ alacritty-config tabspaces '"delete"'
# Set tabspaces to "delete", which wont work
```
### GUI
The GUI is somewhat more self-explanatory. You start it by running `alacritty-config-gui`.
The basic unit of order is the tab, and there are expandable sections for you convenience.
<hr/>
Have fun!