https://github.com/unrizen/zs
automatic TODO completion, designed for use with groq + nixos + nvim
https://github.com/unrizen/zs
ai groq groq-ai groq-api nixos nvim vim
Last synced: about 2 months ago
JSON representation
automatic TODO completion, designed for use with groq + nixos + nvim
- Host: GitHub
- URL: https://github.com/unrizen/zs
- Owner: unrizen
- Created: 2024-12-11T16:59:48.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-12-25T15:55:42.000Z (over 1 year ago)
- Last Synced: 2025-02-17T15:13:57.267Z (over 1 year ago)
- Topics: ai, groq, groq-ai, groq-api, nixos, nvim, vim
- Homepage:
- Size: 2.24 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# zs - autocomplete your TODOs w/ ai
Designed for use with groq + nixos + vim.
# How to Install
**Setup your $GROQ_API_KEY**
Find it here: [https://console.groq.com/keys](https://console.groq.com/keys)
**Paste this command for a quick install to ~/.local/bin/zs**
```sh
FILE_PATH="$HOME/.local/bin/zs"; DOWNLOAD_URL="https://raw.githubusercontent.com/unrizen/zs/refs/heads/dev/zs"; if [ -f "$FILE_PATH" ]; then echo "The file $FILE_PATH already exists."; read -p "Do you want to overwrite it? (y/n): " answer; case $answer in [Yy]* ) echo "Proceeding with download."; curl -L -o "$FILE_PATH" "$DOWNLOAD_URL" && echo "Download completed successfully." && chmod +x "$FILE_PATH" && echo "Made $FILE_PATH executable." || echo "Download failed.";; * ) echo "Aborting operation.";; esac; else echo "Downloading zs."; curl -L -o "$FILE_PATH" "$DOWNLOAD_URL" && echo "Download completed successfully." && chmod +x "$FILE_PATH" && echo "Made $FILE_PATH executable." || echo "Download failed."; fi
```
# How to Use
1. Write a TODO comment.
```javascript
// TODO: Add more cowbell
console.log("🐄🛎️")
```
2. Highlight a snippet of code in vim and pipe it to `zs`.
```
:'<,'>!zs
```
3. The TODOs in the snippet will be completed and injected back into the buffer.
```javascript
console.log("🐄🛎️🐄🛎️🐄🛎️🐄🛎️🐄🛎️🐄🛎️🐄🛎️🐄🛎️🐄🛎️🐄🛎️")
```
# Open Issues
- [ ] [Nixos packaging](https://github.com/unrizen/zs/issues/1)
- [ ] [Env var validation](https://github.com/unrizen/zs/issues/2)
- [ ] [Language-specific error formatting](https://github.com/unrizen/zs/issues/3)
Help is appreciated ❤️
[𝕏](https://x.com/_unrizen) | [Discord](https://discord.gg/kABMK5pHAA)