https://github.com/zdharma-continuum/zsh-startify
https://github.com/zdharma-continuum/zsh-startify
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zdharma-continuum/zsh-startify
- Owner: zdharma-continuum
- License: other
- Created: 2021-11-06T11:03:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T04:44:31.000Z (about 2 years ago)
- Last Synced: 2025-01-13T14:19:21.617Z (5 months ago)
- Language: Shell
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [zsh-startify](#zsh-startify)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Any plugin manager](#any-plugin-manager)
- [zinit](#zinit)
- [Quick Start](#quick-start)
- [Zstyles](#zstyles)
# zsh-startify
A plugin that aims at providing what [vim-startify](https://github.com/mhinz/vim-startify) plugin does, but in Zsh. The
analogy isn't fully easy to make. `vim-startify` states:
> It provides dynamically created headers or footers and uses configurable lists to show recently used or bookmarked
> files and persistent sessions.
zsh-startify:
- shows recently used files if used by a shell-utill command, with name of the command(s) on othe right,
- shows recently used vim files,
- will show active tmux sessions,
- will show statistics of most popular aliases in use,
- will show recently visited projects (i.e. `git` repositories, but also directories with a `Makefile`, a
`CMakeLists.txt`, a `configure` script, etc. – a very advanced feature, inherited from `zsh-startify`'s predecessor:
`zdharma-continuum/zaccumulator` plugin),
- will show recently ran `git` commands, with analysis of e.g. recently checked-out branches,
- will cooperate with any bookmarking plugins to show their bookmarks.
# Screenshots
# Installation
## Any plugin manager
Issue the regular loading command of your plugin manager, pointing it to `zdharma-continuum/zsh-startify`. Then, add
invocation of `zsh-startify` to the end of `~/.zshrc`:
```zsh
% tail -n 5 ~/.zshrc (git)-[master●]
#zmodload -i zsh/sched
#schedprompt
# ADD TO ~/.zshrc
zsh-startify
```
## [Zinit](https://github.com/zdharma-continuum/zinit)
```zsh
# Option A – normal load without Turbo-Mode
zinit ice atload'zsh-startify'
zinit load zdharma-continuum/zsh-startify
# Option B – a load with Turbo-Mode being in use
zinit ice wait'0' lucid atload'zsh-startify'
zinit load zdharma-continuum/zsh-startify
```
The first option (A) loads the plugin synchronously, at the time of execution of the `zinit load ...` command. The
second option (B) loads in an asynchronous manner, 0 seconds after the prompt being first displayed.
# Quick Start
`zsh-startify` accumulates data in its own history file. To pre-fill it quickly with a few of entries (basing on the
regular history) you can run the `__from-zhistory-accumulate` command.
## Zstyles
The zstyles used to configure the plugin (add such commands anywhere in the `zshrc`):
```zsh
zstyle ":plugin:zsh-startify:shellutils" size 5 # The size of the recently used file list (default: 5)
zstyle ":plugin:zsh-startify:vim" size 5 # The size of the recently opened in Vim list (default: 5)
```