Repository files navigation

PyEdit is a terminal-based text editor inspired by Vim, implemented in Python. It provides a modal editing experience, file explorer with live preview, search, undo/redo, and more—all within your terminal. PyEdit is designed for speed, efficiency, and extensibility, making it a great choice for developers who love working in the terminal.

• Modal Editing: Normal, Insert, Visual, Command, Search, and File Explorer modes.
• Vim-like Keybindings: Familiar navigation and editing keys (h/j/k/l,i,v,:,/, etc.).
• File Explorer Sidebar: Browse and open files and directories, with a live preview pane that resizes with your terminal.
• Search: Powerful in-buffer and file search with regex support.
• Undo/Redo: Full undo/redo support for editing operations.
• Status Bar: Displays mode, file name, modification status, and cursor position.
• Command Mode: Save, quit, open files, and more with:commands.
• Visual Mode: Select, copy, and delete text visually.
• AI Autocomplete: (Optional) Press Tab in insert mode for AI-powered code suggestions (requires configuration).
• Multi-Model AI Support: Switch between different AI models (Groq, Gemini) for code completion and AI tools.
• AI Tools: Use:ai <action> commands for code refactoring, documentation, explanation, translation, code generation, and more (see below).
• Lightweight & Fast: Minimal dependencies, runs in any terminal with Python and curses.

• Python 3.7+
• Unix-like terminal (Linux, macOS, or Windows with WSL/compatible terminal)
• Pythoncurses module (pre-installed on most Unix systems; for Windows, installwindows-curses via pip)

1. Clone the repository:

   git clone<repo-url>cd neovim_clone

2. (Windows only) Install curses:

   pip install windows-curses

Run the editor from your terminal:

python py_edit.py [filename]

• If[filename] is provided, it will open or create that file.
• If not, a new buffer is opened.

• NORMAL: Navigation, commands (default)
• INSERT: Text input (pressi)
• VISUAL: Select text (pressv)
• COMMAND: Type :commands (press:)
• SEARCH: Search text (press/)
• FILE EXPLORER: File browser (presse or:explorer)

• Type pattern, Enter to search, ESC to cancel

The file explorer is a two-pane sidebar:

• Left pane: Shows the directory stack and contents. Navigate with your keyboard.
• Right pane: Instantly previews the selected file (up to the full width of your terminal).
• Toggle the explorer:
  • Presse in normal mode
  • Or type:explorer in command mode (works from any mode)

• When you select a file and press Enter/l/right, it opens in the editor and exits explorer mode.
• When you select a directory and press Enter/l/right, it enters that directory.
• You can also use:explorer at any time to open the explorer.

PyEdit supports multiple AI models for code completion and AI tools. You can switch between different models based on your preferences and API availability.

• Groq: Fast, reliable AI model using Llama3-70B (requiresGROQ_API_KEY)
• Gemini: Google's latest Gemini 2.0 Flash model (requiresGEMINI_API_KEY)

1. Get API Keys:

   • Groq: Sign up atgroq.com and get your API key
   • Gemini: Get API key fromGoogle AI Studio

2. Configure Environment:Create a.env file in the project root:

   GROQ_API_KEY=your_groq_api_key_hereGEMINI_API_KEY=your_gemini_api_key_here

3. Model Management:

   • View current model::ai model
   • Switch models::ai model groq or:ai model gemini
   • View available models::ai models
   • Get detailed info::ai info

The current AI model is displayed in the status bar. You can switch between models at any time:

:ai model groq# Switch to Groq:ai model gemini# Switch to Gemini:ai models# Show available models:ai info# Show detailed model information

Your model preference is automatically saved and will be restored when you restart PyEdit.

PyEdit features a suite of AI-powered tools accessible via the command mode. These tools leverage the currently selected AI model to help you write, understand, and manage code more efficiently.

Type:ai <action> [args] in command mode. Example:

:ai refactor:ai doc:ai explain:ai testgen:ai review:ai nl2code create a function that sorts a list:ai translate javascript:ai search file I/O:ai commitmsg:ai chat How do I use decorators in Python?:ai snippet HTTP GET request in Python

• refactor: Refactors the current buffer for readability and efficiency. The buffer is replaced with the improved code.
• doc: Generates a docstring or inline comments for the code in the buffer. The result is shown in a popup.
• explain: Explains what the code in the buffer does in plain English. The explanation is shown in a popup.
• testgen: Generates a unit test (e.g., pytest) for the code in the buffer. The buffer is replaced with the generated test code.
• review: Reviews the code in the buffer and suggests improvements or points out bugs. The review is shown in a popup.
• nl2code: Converts a natural language instruction into code (e.g.,:ai nl2code create a function that sorts a list). The buffer is replaced with the generated code.
• translate: Translates the code in the buffer to another language (e.g.,:ai translate javascript). The buffer is replaced with the translated code.
• search: Performs a semantic search across all Python files in the project for code related to the query (e.g.,:ai search file I/O). The results are shown in a popup.
• commitmsg: Generates a concise git commit message for the current buffer's content. The message is shown in a popup.
• chat: Opens a chat with the AI for general programming questions or advice. The response is shown in a popup.
• snippet: Generates a code snippet based on a description (e.g.,:ai snippet HTTP GET request in Python). The buffer is replaced with the generated snippet.

• refactor,nl2code,translate,snippet,testgen will automatically replace the buffer with the AI's code output.

• doc,explain,review,search,commitmsg,chat will always show their result in a scrollable popup window, even for short responses.

Contributions are welcome! Please open issues or submit pull requests for bug fixes, new features, or improvements.

• Inspired by Vim and other modal editors.

This project is licensed under the MIT License.