workstyle

Crates.ioworkstyle
lib.rsworkstyle
version0.8.2
sourcesrc
created_at2019-09-19 18:02:01.345314
updated_at2022-02-20 21:34:42.776761
description Workspaces with style! This program will dynamically rename your workspaces to indicate which programs are running in each workspace. It uses the i3 ipc protocol, which makes it compatible with sway and i3. By default, each program is mapped to a unicode character for concision. The short description of each program is configurable. In the absence of a config file, one will be generated automatically. See ${XDG_CONFIG_HOME}/workstyle/config.yml for details.
homepagehttps://github.com/pierrechevalier83/workstyle
repositoryhttps://github.com/pierrechevalier83/workstyle
max_upload_size
id166023
size33,603
Pierre Chevalier (pierrechevalier83)

documentation

README

Workstyle

Sway/i3 workspaces with style:

This application will dynamically rename your workspaces to indicate which programs are running in each one.

A picture is better than a thousand words!

  • The workspace bar could look like this (uses waybar) alt tag

  • In context: alt tag

Note: if you are using waybar and want the workspaces to be displayed with their number, like in the screenshot, please set "format": "{icon}",. See the waybar wiki for more information on configuring waybar.

Installation

cargo install workstyle

Usage

Simply run the executable:

workstyle
workspace --help

will give you some more context.

Sway configuration

Add this line to your sway config:

exec_always --no-startup-id workstyle &> /tmp/workstyle.log

You may also want to control the log level with the environment variable: RUST_LOG to error, info or debug.

Note that since your workspaces will be renamed all the time, you should configure your keybindings to use numbered workspaces instead of assuming that the name is the number: Prefer

    bindsym $mod+1 workspace number 1

over

    bindsym $mod+1 workspace 1

SystemD integration

Alternatively you can use the workstyle.service file to configure systemd to automatically start workstyle after you login

Copy workstyle.service to $HOME/.config/systemd/user/

and run

systemctl --user enable workstyle.service
systemctl --user start workstyle.service

Configuration

The main configuration consists of deciding which icons to use for which applications.

The config file is located at ${XDG_CONFIG_HOME}/workstyle/config.toml or /etc/xdg/workstyle/config.toml (the former takes precedence over the latter). It will be generated if missing. Read the generated file. The syntax is in TOML and should be pretty self-explanatory.

When an app isn't recogised in the config, workstyle will log the application name as an error. Simply add that string (case insensitive) to your config file, with an icon of your choice.

If no matching icon can be found in the config, a blank space will be used. To override this, set the default icon in the config as per below:

[other]
fallback_icon = "your icon"

If you prefer not to have multiple copies of the same icon when there are multiple matching windows, set this config option:

[other]
deduplicate_icons = true

Note that the crate find_unicode can help find a unicode character directly from the command line. It now supports all of nerdfonts unicode space.

Commit count: 134

cargo fmt