Skip to content

Commit

Permalink
feat(README): add a ToC
Browse files Browse the repository at this point in the history
  • Loading branch information
efugier committed Nov 13, 2023
1 parent 3960885 commit fd73438
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# smartcat (sc) 🐈‍⬛

Puts a brain behind cat!
Puts a brain behind `cat`! WIP cli interface to bring language models in the Unix ecosystem 🐈‍⬛

WIP cli interface to language models to bring them in the Unix ecosystem

```
Putting a brain behind `cat`. WIP cli interface to bring language models in the Unix ecosystem 🐈‍⬛
- [Installation](#installation)
- [A few examples to get started](#a-few-examples-to-get-started)
- [Manipulate file and text streams](#manipulate-file-and-text-streams)
- [Integrating with editors](#integrating-with-editors)
- [Configuration](#configuration)
- [Developping](#developping)

```text
Usage: sc [OPTIONS] [PROMPT]
Arguments:
Expand Down Expand Up @@ -125,12 +128,12 @@ Frameworks and libraries, like stations, stand so proud
And programmers, conductors, who make the engines loud.
```

## Integrating with editors
### Integrating with editors

The key for a good integration in editors is a good default prompt (or set of) combined with the `-c` flag for precising the task at hand.
The `-r` flag can be used to decide whether to replace or extend the selection.

### Vim
#### Vim

Start by selecting some text, then press `:`. You can then pipe the selection content to `smartcat`.

Expand Down Expand Up @@ -158,7 +161,7 @@ will **append** at the end of the current selection the result of the language m

With some remapping you may have your most reccurrent action attached to few keystrokes e.g. `<leader>wt`!

### Helix
#### Helix

Same concept, different shortcut, simply press the pipe key to redirect the selection to `smarcat`.

Expand Down

0 comments on commit fd73438

Please sign in to comment.