https://github.com/interwebologist/nerdprompt
🧠 Colorful Perplexity.AI search for Terminal Hackers: AI assistant designed for the tricked out terminal. AI responses with code syntax highlighting, ascii or Unicode custom dividers, emoji bullet points, match your current VIM theme with colored headers, sprinkle in bold and italic text. Should work with OpenAI API's Cohere, Anthropic, & ChatGPT.
https://github.com/interwebologist/nerdprompt
anthropic anthropic-claude artificial-intelligence bbs chatgpt cohere cohere-ai llm openai openai-api perplexity perplexity-ai terminal terminal-based vim
Last synced: 2 months ago
JSON representation
🧠 Colorful Perplexity.AI search for Terminal Hackers: AI assistant designed for the tricked out terminal. AI responses with code syntax highlighting, ascii or Unicode custom dividers, emoji bullet points, match your current VIM theme with colored headers, sprinkle in bold and italic text. Should work with OpenAI API's Cohere, Anthropic, & ChatGPT.
- Host: GitHub
- URL: https://github.com/interwebologist/nerdprompt
- Owner: interwebologist
- Created: 2025-04-12T05:09:15.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-06-03T12:06:41.000Z (4 months ago)
- Last Synced: 2025-06-03T22:14:50.878Z (4 months ago)
- Topics: anthropic, anthropic-claude, artificial-intelligence, bbs, chatgpt, cohere, cohere-ai, llm, openai, openai-api, perplexity, perplexity-ai, terminal, terminal-based, vim
- Language: Python
- Homepage:
- Size: 3.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🧠 NerdPrompt
**AI formatted for tricked out terminals now with customizable ANSI colors, emoji's, ASCII art dividers, Code detection and code syntax highlighting with follow up questions (Threads)** (Currently tested with Perplexity.AI, should work with ChatGPT, Claude, Cohere)
**In NeoVIM w/ "leader key + np hotkey" [HERE](https://github.com/interwebologist/neovim_config/blob/fd8320c6e7d1a5ed117c335bf4a620bad66f6995/init.lua#L32-L50)**
With Noice installed this will give a popup floating middle of screen before spliting the screen to run NerdPrompt.
---
## 🚀 Features
- Custom Emoji, ANSI (Colors), or ASCII-enhanced bullet points
- Custom Horizontal Dividers
- Custom headers. Match your VIM theme colors, underline, etc
- Supports bold, italic, and bold italic text rendered directly in the terminal.
- Removes citation markers like "[1]" for a cleaner output in perplexity.ai (clickable citations coming)
- Code syntax highlighting. Choose from common themes. Create your own.
- Custom horizontal dividers for code blocks.
---
## 🔧 Installation
Follow these steps to install Nerd Prompt:
1. **Clone the repository:**
```
git clone https://github.com/interwebologist/NerdPrompt.git
cd NerdPrompt
```
2. **Create and activate a virtual environment (recommended):**
```
python3 -m venv venv
# On Linux or macOS:
source venv/bin/activate
# On Windows:
venv\Scripts\activate
```
3. **Install dependencies:**
```
pip install -r requirements.txt
```
4. **Set up your API key (see below).**
---
**Note:**
Using a virtual environment (`venv`) keeps dependencies isolated from your system Python and is best practice for Python projects.
---
## 🔑 Setting Up Your API Key
To use **Nerd Prompt**, you need an API key from Perplexity.ai. Here's how to get it:
1. **Log in to Perplexity.ai**: Visit [www.perplexity.ai](https://www.perplexity.ai) and log in to your account.
2. **Navigate to Settings**: Click on the **Settings** icon (bottom-left corner).
3. **Access the API Tab**: Select the **API** tab from the menu.
4. **Generate or Copy Your API Key**: Click "Generate API Key" if you don't already have one, or copy your existing key.
5. Save your API key securely.
---
## 🛠️ Configuring Your API Key
1. Create a `.env` file in the project directory:
```bash
touch .env
```
2. Add your API key to the `.env` file:
```plaintext
API_KEY=your_api_key_here
```
3. The project will automatically load the key from the `.env` file when you run it.
---
## 🖥️ Usage Instructions
Run the script with your query as an argument:
```bash
python nerd_prompt.py "What is the capital of France?"
```
I suggest setting up an alias you can fire of python commands with out activiating the python enviroment like this:
```bash
/path/to/your/venv/bin/python script.py
```
---
## ✨ Markdown Formatting in Terminal
The tool supports formatting for the Terminal:
- **Headers** are styled with different colors. Example:
- Green for `# Header`
- Blue for `## Subheader`
- Red for `### Sub-subheader`
- Text styling includes:
- **Bold**
- *Italic*
- ***Bold Italic***
- Emoji-enhanced bullet points like 🚀, 🔥, and ✨ add personality to your terminal output.
- Add your own ASCII art dividers or dividers with emoji's
---
## 💡 Best Practices
- Keep your API key private—do not share it publicly.
- Ensure you have sufficient credits in your Perplexity.ai account to make queries.
- Use Python 3.8 or higher for compatibility.
---
## ❓ Troubleshooting
If you encounter issues:
1. Ensure your `.env` file contains a valid API key.
2. Verify that all dependencies are installed (`pip install -r requirements.txt`).
3. Check your Perplexity.ai account for sufficient credits or active API keys.
For further assistance, consult [Perplexity's Help Center](https://www.perplexity.ai/help-center).
---
## 🎨 Code Syntax Highlighting Themes
This project uses [Pygments](https://pygments.org/) for code syntax highlighting. You can customize the appearance of code blocks by selecting one of the many available Pygments styles. For a live preview of each theme, visit the [Pygments demo page](https://pygments.org/demo/).
**To set a style, configure your formatter in the config.yaml with the desired style name.**
For example, in Python:
### Available Code Styles
Below is a list of supported syntax highlighting themes:
- abap
- algol
- algol_nu
- arduino
- autumn
- bw
- borland
- coffee
- colorful
- default
- dracula
- emacs
- friendly_grayscale
- friendly
- fruity
- github-dark
- gruvbox-dark
- gruvbox-light
- igor
- inkpot
- lightbulb
- lilypond
- lovelace
- manni
- material
- monokai
- murphy
- native
- nord-darker
- nord
- one-dark
- paraiso-dark
- paraiso-light
- pastie
- perldoc
- rainbow_dash
- rrt
- sas
- solarized-dark
- solarized-light
- staroffice
- stata-dark
- stata-light
- tango
- trac
- vim
- vs
- xcode
- zenburn
Enjoy using **Nerd Prompt**! 🚀