deblan-mirror/gum
deblan-mirror/gum
1
0
Fork 0
mirror of https://github.com/charmbracelet/gum synced 2024-05-15 12:46:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(demos): Add editor and commit demos

Browse source
This commit is contained in:
Maas Lalani 2022-07-13 16:26:58 -04:00
parent 4d98a8fa6f
commit 0f4b98c2ad
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -198,16 +198,6 @@ See the [examples](./examples/) directory for more real world use cases.
How to use `gum` in your daily workflows:
#### Open files in your `$EDITOR`
By default `gum filter` will display a list of all files (searched recursively)
through your current directory, it has some sensible ignored defaults (`.git`,
`node_modules`). You can use this to pick a file and open it in your `$EDITOR`.
```bash
$EDITOR $(gum filter)
```
#### Write a commit message
Prompt for user input to write git commit messages with a short summary and
@ -222,6 +212,18 @@ git commit -m "$(gum input --width 50 --placeholder "Summary of changes")" \
-m "$(gum write --width 80 --placeholder "Details of changes")"
```
<img src="https://stuff.charm.sh/gum/commit.gif" width="600" alt="Running the ./examples/commit.sh script to commit to git">
#### Open files in your `$EDITOR`
By default `gum filter` will display a list of all files (searched recursively)
through your current directory, it has some sensible ignored defaults (`.git`,
`node_modules`). You can use this to pick a file and open it in your `$EDITOR`.
```bash
$EDITOR $(gum filter)
```
#### Connect to a TMUX session
Pick from a running `TMUX` session and attach to it if not inside `TMUX` or