https://github.com/olets/zsh-window-title
A zsh plugin for informative terminal window titles. ~1000 unique cloners as of July '24
https://github.com/olets/zsh-window-title
command-line terminal zsh zsh-plugin
Last synced: 2 months ago
JSON representation
A zsh plugin for informative terminal window titles. ~1000 unique cloners as of July '24
- Host: GitHub
- URL: https://github.com/olets/zsh-window-title
- Owner: olets
- License: other
- Created: 2021-09-25T00:51:38.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-24T01:38:41.000Z (over 1 year ago)
- Last Synced: 2025-02-18T09:51:16.742Z (9 months ago)
- Topics: command-line, terminal, zsh, zsh-plugin
- Language: Shell
- Homepage:
- Size: 65.4 KB
- Stars: 33
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
- awesome-zsh-plugins - window-title - Adds informative tiles to your terminal windows. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - window-title - Adds informative tiles to your terminal windows. (Plugins / ZSH on Windows)
README
# zsh-window-title 
> A zsh plugin for informative terminal window titles
- [Requirements](#requirements)
- [Installation](#installation)
- [Homebrew](#homebrew)
- [With a shell plugin manager](#with-a-shell-plugin-manager)
- [Manual](#manual)
- [Usage](#usage)
- [macOS Terminal.app users](#macos-terminalapp-users)
- [Oh-My-Zsh users](#oh-my-zsh-users)
- [CLI](#cli)
- [Options](#options)
- [Changelog](#changelog)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#License)
## Requirements
- Zsh
## Installation
### Homebrew
```shell
brew install olets/tap/zsh-window-title
```
### With a shell plugin manager
1. Install zsh-window-title with a zsh plugin manager. Each has their own way of doing things. See your package manager's documentation or the [zsh plugin manager plugin installation procedures gist](https://gist.github.com/olets/06009589d7887617e061481e22cf5a4a).
After adding the plugin to the manager, restart zsh:
```shell
exec zsh
```
### Manual
1. Download [the latest `zsh-window-title` binary](https://github.com/olets/zsh-window-title/releases/latest)
1. Either
- Put the file `zsh-window-title` in a directory in your `PATH` and add `source zsh-window-title` to your `~/.zshrc` file
- Add `source the/path/to/zsh-window-title` to your `~/.zshrc` file
1. Restart zsh:
```shell
exec zsh
```
## Usage
Once zsh-window-title is installed, your terminal window title will be
- `/` when nothing's running
- `/ - ` when something's running
- `/ - ` when something's running and the first word of the last run command is one of the configured prefixes.
For example, after running `sleep 2` in the directory `~/olets/zsh-window-title`, the window title will be `olets/zsh-window-title - sleep`. After running `sudo sleep 2`, it will be `olets/zsh-window-title - sudo sleep`.
Note that the command is not parsed. If you run `echo hello world && sleep 10`, the window title will show `echo` for the duration, not `echo` for a moment and then `sleep`.
The number of path segments to show is configurable, and so are the prefixes. See [Options](#options).
### macOS Terminal.app users
By default macOS's Terminal app will control the window title. Disable that by:
> Preferences > Profiles > Window > Title --> uncheck everything.
### Oh-My-Zsh users
By default OMZ will control the terminal window title. Disable that by adding
```shell
DISABLE_AUTO_TITLE=”true”
```
to your `~/.zshrc` file.
### CLI
```shell
zwt restore-defaults
(help | --help | -h)
(version | --version | -v)
```
- `zwt restore-defaults` Restore options to their defaults in the current session. See [Options](#options).
- `zwt (help | --help | -h)` Show the manpage.
- `zwt (version | --version | -v)` Print the command name and version.
## Options
Variable | Type | Default | Use
---|---|---|---
ZSH_WINDOW_TITLE_COMMAND_PREFIXES | array | `( sudo )` | If the command starts with one of these terms, show it and the following word. (With the default, running `sudo sleep 10` will add `sudo sleep` to the window title.)
ZSH_WINDOW_TITLE_DEBUG | integer | `0` | If non-zero, print hook debugging messages
ZSH_WINDOW_TITLE_DIRECTORY_DEPTH | integer | `2` | How many directory levels to display
ZWT_DEBUG | integer | `0` | If non-zero, print CLI debugging messages
## Changelog
See the [CHANGELOG](CHANGELOG.md) file.
## Roadmap
See the [ROADMAP](ROADMAP.md) file.
## Contributing
Thanks for your interest. Contributions are welcome!
> Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
Check the [Issues](https://github.com/olets/zsh-window-title/issues) to see if your topic has been discussed before or if it is being worked on.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
## License
zsh-window-title by Henry Bley-Vroman is licensed under CC BY-NC-SA 4.0 with a human rights condition from Hippocratic License 2.1. Persons interested in using or adapting this work for commercial purposes should contact the author.
For the full text of the license, see the [LICENSE](LICENSE) file.