Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loiccoyle/shiv
🐚 Run shell commands from any text box, kinda...
https://github.com/loiccoyle/shiv
input-method linux shell
Last synced: about 2 months ago
JSON representation
🐚 Run shell commands from any text box, kinda...
- Host: GitHub
- URL: https://github.com/loiccoyle/shiv
- Owner: loiccoyle
- License: mit
- Created: 2023-03-11T03:48:22.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T14:28:52.000Z (about 1 year ago)
- Last Synced: 2023-10-19T15:38:48.345Z (about 1 year ago)
- Topics: input-method, linux, shell
- Language: Rust
- Homepage:
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shiv
`shiv` is a jankier version of [`shin`](https://github.com/p-e-w/shin), which does not require `ibus`.
It allows you to run shell commands from any text box.
## ❓ How
When started, `shiv` grabs the user's keyboard and creates a virtual pass-through keyboard.
It keeps track of the user's inputs and forwards them selectively to the virtual keyboard.
When the enter key is pressed, the provided command is run and its output is pasted in (or typed out using the `-T` option).
> **Note:** To create and grab the keyboard devices `shiv` needs elevated privileges. To help with this, a `polkit` file is available in the [`extra`](https://github.com/loiccoyle/shiv/tree/main/extra) folder. The command, however, is run as the invoking user.
## 📋 Usage
`shiv` is designed to be bound to a key combination.
For example, using [`sxhkd`](https://github.com/baskerville/sxhkd):
```sxhkd
super + i; any + g
sudo -E shiv -d 5 "sgpt"
super + i; any + f
sudo -E shiv -d 5 "figlet"
super + i; any + i
sudo -E shiv -d 5
```
As always, if in doubt, see the `--help`:
```console
$ shiv --help
Shiv: shell access everywhere.
Shiv allows you to run shell commands from any text box.
When started, it listens for keyboard inputs, on Enter it will run the command and write the output.
The recommended way to use shiv is to bind it to a key combination.
Examples:
• On demand python shell:
$ shiv "python -c"
• Query ChatGPT:
$ shiv "sgpt"
• On demand calculator and conversions:
$ shiv "qalc -t"
• ASCII art:
$ shiv "figlet"
Usage: shiv [OPTIONS] [PRE_CMD]
Arguments:
[PRE_CMD]
Prefix input with this command
[default: "bash -c"]
Options:
-T, --type-output
Type out the command output instead of pasting it
-d, --key-delay
Add delay between keypresses, in ms, values between 1 and 10 work best
[default: 5]
-v, --verbose...
Increase verbosity
-q, --quiet...
Decrease verbosity
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
Note: shiv requires priviledges to create and access keyboard devices.
```
## ✔️ TODO
- [x] add a cli
- [x] add tests
- [x] add ci
- [x] Run command in separate thread, and still allow user to cancel running command.
- [ ] look into better permission handling
- [ ] test on different layouts
- [ ] Give some feedback that the command is running
- [ ] Look into