deblan-mirror/gum
deblan-mirror/gum
1
0
Fork 0
mirror of https://github.com/charmbracelet/gum synced 2024-05-22 08:06:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(log): add log to the readme

Browse source
This commit is contained in:
Maas Lalani 2023-11-08 10:59:16 -05:00
parent 86dbd9c70f
commit 12ef4d3085
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -380,6 +380,23 @@ named emojis see the [GitHub API](https://api.github.com/emojis).
<img src="https://stuff.charm.sh/gum/format.gif" width="600" alt="Running gum format for different types of formats" />
## Log
`log` logs messages to the terminal at using different levels and styling using
the [`charmbracelet/log`](https://github.com/charmbracelet/log) library.
```bash
# Log some debug information.
gum log --structured --level debug "Creating file..." name file.txt
# DEBUG Unable to create file. name=temp.txt
# Log some error.
gum log --structured --level error "Unable to create file." name file.txt
# ERROR Unable to create file. name=temp.txt
```
See [`charmbracelet/log`](https://github.com/charmbracelet/log) for more usage.
## Examples
See the [examples](./examples/) directory for more real world use cases.