https://github.com/bigpick/spaceduck-colorls

A spaceduck theme for colorls
https://github.com/bigpick/spaceduck-colorls

Last synced: 5 months ago
JSON representation

A spaceduck theme for colorls

• Host: GitHub
• URL: https://github.com/bigpick/spaceduck-colorls
• Owner: bigpick
• License: mit
• Created: 2021-06-04T20:57:15.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-06-04T21:40:36.000Z (about 5 years ago)
• Last Synced: 2025-06-03T01:51:40.109Z (about 1 year ago)
• Size: 603 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Spaceduck for [colorls](https://github.com/athityakumar/colorls)

> A [spaceduck](https://github.com/pineapplegiant/spaceduck) theme for [colorls](https://github.com/athityakumar/colorls).

![Screenshot](./screenshot.png)

> (note: `ls` has been aliased to `colorls --sd --dark` above)

## Install

First, get the source code via one of the download methods, then proceed to activating.

### Getting Theme

#### Download using Git

If you are a git user, you can install the theme and keep up to date by cloning the repo:

```bash

git clone git@github.com:bigpick/spaceduck-colorls.git

```

#### Download manually

Download using the [GitHub .zip download](https://github.com/bigpick/spaceduck-colorls/archive/main.zip) option and unzip them.

### Activating theme

1. First you need to have installed [colorls](https://github.com/athityakumar/colorls#installation). Ensure you are running the latest release of colorls, as support for hex string values were added as of the [1.4.2 release](https://github.com/athityakumar/colorls/releases/tag/v1.4.2)

2. (Optionally) Make a backup of your current dark colorscheme:

    ```bash

    cp ~/.config/colorls/dark_colors.yaml ~/.config/colorls/dark_colors.yaml.backup

    ```

3. Copy the [`dark_colors.yaml`](https://github.com/bipick/spaceduck-colorls/blob/main/dark_colors.yaml) file to the dark color scheme location for colorls:

    ```bash

    cp dark_colors.yaml ~/.config/colorls/dark_colors.yaml

    ```

4. Use the `--dark` option when utilizing `colorls`:

    ```bash

    colorls --dark

    # Additionally: alias ls="colorls --dark"

    # or, perhaps more sanely: alias cls="colorls --dark"

    ```

---

## Samples

Some examples of a select set of `colorls` options (see the colorls repo for full optional flags).

### File Sizes

> Notice the sizing coloration based on small/medium/large size in the 5th column.

![file-size-screenshot](./sample/spaceduck_sizes.png)

### Tree

![tree-screenshot](./sample/spaceduck_tree.png)

### Git Status (addition, modified, deleted, unchanged, untracked)

> Shown: unchanged (green), modified (yellow), untracked (orange); Not-shown: addition (cyan), deletion (red)

![git-demo-screenshot](./sample/spaceduck_git.png)

## License

[MIT License](./LICENSE)