commit - 5d27ac25e077bc38111026641f43253e83f371be
commit + f6dfbf0d0eaa9ad53536d700bb98396f4d302ed9
blob - e06f9cddb9228e794bd5f476d7b4bc8afce53dca
blob + 229c40dbf111155e4e7280cd2c6750d8a5b55b01
--- README.md
+++ README.md
## Tour of cogni
-
An gallery of examples to get the inspiration flowing
+> :warning: `cogni` uses the [OpenAI API](https://openai.com/blog/openai-api), thus *any data fed into program will be sent to OpenAI*. Please be mindful of security and privacy implications.
+
### In the Shell
```sh
# Create a ffmpeg cheatsheet from man page
$ man ffmpeg | cogni -T 300 -s "Create a cheatsheet given a man page. Output should be in Markdown, and should be a set of example usages under headings." > cheatsheet.md
+
+# Catchup after long hiatus from git repo
+$ git show -n 3 | cogni -s "What was I working on recently?"
```
### In Emacs
(global-set-key (kbd "M-c") #'leoshimo/cogni-on-region)
```
+This binding is useful across a wide range of tasks, for example:
+
+- Normalizing non-uniform text - e.g. unstructured logs to structured JSON events.
+- Editing or organizing text semantically - e.g. rewording or grouping by category.
+- Generating summary for an Org Agenda doc.
+
### In Vim
-Vim can run external shell commands on entire buffer or visual selection. See `h :!` in vim.
+Vim can run external shell commands on entire buffer or visual selection to
+power similar workflows possible form Emacs. See `h :!` in vim.
-This allows workflows like:
-1. Select a list of fruits in visual mode
+For example, given a bulleted list of fruits, it an be sorted by color by:
+
+1. Selecting the list of fruits in visual mode
2. Type `:!cogni -s "Sort this list by color"`
-3. Selection is replaces - list of fruits is sorted by color