Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daltonsw/stylish

Simple and intuitive lscolors configuration. Put that glam in your term.
https://github.com/daltonsw/stylish

bash brew bubbletea colors golang lipgloss ls tree tui zsh

Last synced: 3 days ago
JSON representation

Simple and intuitive lscolors configuration. Put that glam in your term.

Host: GitHub
URL: https://github.com/daltonsw/stylish
Owner: DaltonSW
License: gpl-3.0
Created: 2025-01-02T23:24:02.000Z (25 days ago)
Default Branch: main
Last Pushed: 2025-01-24T13:52:22.000Z (4 days ago)
Last Synced: 2025-01-24T14:34:51.872Z (3 days ago)
Topics: bash, brew, bubbletea, colors, golang, lipgloss, ls, tree, tui, zsh
Language: Go
Homepage: https://dalton.dog/stylish
Size: 5.91 MB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

A simple and intuitive way to create and apply stylish config files 🖌️

Works with `ls`, `tree`, `fd`, `exa`, and anything else that respects `$LS_COLORS`

Why use `stylish` ❓

- NO file editing!
- NO dealing with encoding strings!
- NO manual mapping of hex codes to 8-bit colors!
- NO blindly working without an actual preview!
- NO need to hunt down scattered, poor documentation and references!

Quick Start 🌩️

If you are comfortable with the defaults and just want to fast track your way to a pretty terminal, then you're just 2 steps away.

- Install via one of the methods below
- Add the following to your shell's init script:
```sh
eval $(stylish apply default)
alias ls=ls --color=auto
```
- Be stylish on every future shell launch

Installation ⬇️

> [!IMPORTANT]
> If you're on Mac, do the following alongside the normal installation

Ensure you have `coreutils` installed AND added to your `PATH` by following the instructions on the [coreutils brew page](https://formulae.brew.sh/formula/coreutils)

### Github Releases 🐙

- Go to the `Releases` tab of the repo [here](https://github.com/DaltonSW/stylish/releases)
- Download the latest binary for your OS
- Place it on your `$PATH` and ensure it is executable

### Homebrew 🍺

- Have `brew` installed
- Run the following:
```sh
brew install daltonsw/tap/stylish
```

### Go 🖥️

- Have `Go`
- Have your `Go` install location on your `$PATH`
- Run the following:
```sh
go install go.dalton.dog/stylish@latest
```

Usage ⚙️

- Start the program with `stylish`. This will:
- Create a `stylish` directory in your user's default config directory (typically `~/.config`)
- Create a `default` theme inside of that directory. **Note:** This theme is intended to be used on a dark background
- With the program running, you're able to create and edit your themes to your heart's content
- Once you're ready to apply a theme, you'll need to add the following to your shell's init file (`~/.bashrc`, `~/.zshrc`, etc.):
- **Required:** `eval $(stylish apply )`
- *Recommended:* `alias ls=ls --color=auto`
- Once your init file is edited, relaunch your shell to start seeing the updated colors.

### P.S.

Want to handle your hex code journey in your terminal too? Check out [termpicker](https://github.com/ChausseBenjamin/termpicker)!

Commands 📜

### `stylish`

*Launch the TUI*

- If you run the program without any subcommands, it will launch you directly into the editor TUI

### `stylish apply [theme]`

*This command turns the theme's YAML files into the final environment variable expected format*

- Converts the given theme's YAML definition files into a `dircolors` compatible file
- Saves the `.dircolors` file in the root of the theme's directory
- Runs `dircolors` on the generated file to get the appropriate `LS_COLORS` string
- Returns a command that's ready to be `eval`'d to automatically export the `LS_COLORS` string to the environment variable

### `stylish example [theme]`

*This command is to make setting up directories for example screenshots significantly easier and quicker*

> [!WARNING]
> This command requires the `tree` command to be installed

- Creates an `example` directory located in your theme's root
- For each style in your theme, a new directory is created matching the style's name
- For each filetype associated with the theme (up to 4), a random filename is generated and a blank file is created with that name and filetype

Shoutouts 🗨️

- [Jess](https://jessicakasper.com) for the great banner!
- [Vivid](https://github.com/sharkdp/vivid) for being a great program and a great reference
- [Catppuccin](https://github.com/catppuccin) for having pretty palettes
- [CharmBracelet](https://github.com/charmbracelet) for the amazing modules for style, form, and function

Contributions 💜

Contributions are very welcome! I'd love for y'all to contribute themes you develop as well as expanding on the defaults to make them more reasonable. Check out the [CONTRIBUTING](./CONTRIBUTING.md) file for specifics.