https://github.com/zdharma-continuum/zconvey
Send notifications and commands to all or selected Zshell instances
https://github.com/zdharma-continuum/zconvey
Last synced: 5 months ago
JSON representation
Send notifications and commands to all or selected Zshell instances
- Host: GitHub
- URL: https://github.com/zdharma-continuum/zconvey
- Owner: zdharma-continuum
- License: gpl-2.0
- Created: 2021-11-01T08:03:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-12T19:41:57.000Z (about 1 year ago)
- Last Synced: 2024-11-14T00:29:02.907Z (7 months ago)
- Language: Shell
- Homepage: http://zdharma.org
- Size: 153 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D6XDCHDSBDSDG)
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Introduction](#introduction)
- [Zstyles](#zstyles)
- [Installation](#installation)
- [Zinit](#zinit)
- [Antigen](#antigen)
- [Oh-My-Zsh](#oh-my-zsh)
- [Zgen](#zgen)
- [Information](#information)
# Introduction
Zconvey integrates multiple Zsh sessions. They are given an ID, optionally a NAME (both unique), and can send commands
to each other. Use this to switch all your Zshells to given directory, via `zc-all cd $PWD`! Also, there's
`zc-bg-notify` **script** (not a function), that will show notification under prompt of every active Zsh session. You
can call this script from any program, Bash or GUI.
Video – view on [asciinema](https://asciinema.org/a/156726). You can resize the video by pressing `Ctrl-+` or `Cmd-+`.
[](https://asciinema.org/a/156726)
# Zstyles
The values being set are the defaults. They must be set before loading the plugin.
```zsh
# How often to check if there are new commands (in seconds)
zstyle ":plugin:zconvey" check_interval "2"
# If shell is busy for 22 seconds, the received command will expire and not run
zstyle ":plugin:zconvey" expire_seconds "22"
# Display logo at Zsh start ("text" – display text, "none" – no greeting)
zstyle ":plugin:zconvey" greeting "logo"
# zc won't ask for missing data ("1" has the same effect as always using -a
# option)
zstyle ":plugin:zconvey" ask "0"
# Don't execute zc-ls after doing rename (with zc-rename or zc-take)
zstyle ":plugin:zconvey" ls_after_rename "0"
# Should use faster zsystem's flock when it's possible?
# (default true on Zsh >= 5.3, will revert to mixed zsystem/flock on older
# Zshells)
zstyle ":plugin:zconvey" use_zsystem_flock "1"
# To put commands on command line, Zconvey can use small program "feeder". Or
# "zsh" method, which currently doesn't automatically run the command – to use
# when e.g. feeder doesn't build (unlikely) or when occurring any problems
# with it
zstyle ":plugin:zconvey" output_method "feeder"
# Use zsh/datetime module for obtaining timestamp. "date" – use date command
# (fork)
zstyle ":plugin:zconvey" timestamp_from "datetime"
```
# Installation
**The plugin is "standalone"**, which means that only sourcing it is needed. So to install, unpack `zconvey` somewhere
and add
```zsh
source {where-zconvey-is}/zconvey.plugin.zsh
```
to `zshrc`.
If using a plugin manager, then `Zinit` is recommended, but you can use any other too, and also install with `Oh My Zsh`
(by copying directory to `~/.oh-my-zsh/custom/plugins`).
The plugin integrates with my other plugin [Zsh-Select](https://github.com/zdharma-continuum/zsh-select). Install it
with e.g. Zinit to be able to use `-a` option for `zc` command. It also integrates with
[marzocchi/zsh-notify](https://github.com/marzocchi/zsh-notify), via `cmds/plg-zsh-notify` script.
## [Zinit](https://github.com/zdharma-continuum/zinit)
Add `zinit load zdharma-continuum/zconvey` to your `.zshrc` file. Zinit will clone the plugin the next time you start
zsh. To update issue `zinit update zdharma-continuum/zconvey`.
Zinit can load in [turbo-mode](https://github.com/zdharma-continuum/zinit#turbo-mode-zsh--53), below is an example
configuration, together with adding `zc-bg-notify` to `$PATH`:
```zsh
zinit ice wait"0"
zinit light zdharma-continuum/zconvey
zinit ice wait"0" as"command" pick"cmds/zc-bg-notify" silent
zinit light zdharma-continuum/zconvey
```
## Antigen
Add `antigen bundle zdharma-continuum/zconvey` to your `.zshrc` file. Antigen will handle cloning the plugin for you
automatically the next time you start zsh.
## Oh-My-Zsh
1. `cd ~/.oh-my-zsh/custom/plugins`
1. `git clone [email protected]:zdharma-continuum/zconvey.git`
1. Add `zconvey` to your plugin list
## Zgen
Add `zgen load zdharma-continuum/zconvey` to your .zshrc file in the same place you're doing your other `zgen load`
calls in.
# Information
There are following commands:
- `zc` – sends to other session; use "-a" option to be asked for target and a command to send
- `zc-all` – the same as `zc`, but targets are all other active sessions (with `-f` also busy sessions)
- `zc-rename` – assigns name to current or selected session; won't rename if there's a session with the same name
- `zc-take` – takes a name for current or selected sessions, schematically renames any conflicting sessions
- `zc-ls` – lists all active and named sessions
- `zc-id` – shows ID and NAME of current session
- `zc-logo` – the same as `zc-id`, but in a form of an on-screen logo; bound to Ctrl-O Ctrl-I
- `zc-bg-notify` – in subdirectory `cmds`, link it to `/usr/local/bin`, etc. or load with e.g. Zinit
The main command is `zc` (yet it is rather rarely used, I'm always sending to all sessions with `zc-all`). It is used to
execute commands on other sessions. `zc-ls` is the main tool to obtain overall information on sessions. `zc-take` is a
nice rename tool to quickly name a few sessions. Keyboard shortcut Ctrl-O Ctrl-I will show current session's ID and NAME
in form of an on-screen logo.