BasedSyntax is a powerful, locally-run coding assistant that supercharges your development workflow. It combines the advanced Monaco editor (the engine behind VS Code) with the flexibility of local AI models via Ollama. Use it as a scratchpad, a learning tool, or a powerful code refactoring and analysis companion, all while keeping your code securely on your own machine.
- VS Code Experience, Locally: Enjoy a feature-rich editing experience with syntax highlighting for dozens of languages, Prettier-based code formatting, integrated search, and full undo/redo support.
- Your Personal AI Code Architect: Connects to your local Ollama instance to leverage powerful language models for a wide range of complex tasks:
- Deep Code Analysis: Get detailed, step-by-step explanations of complex code.
- Intelligent Refactoring: Automatically refactor code for readability, performance, and maintainability.
- Proactive Debugging: Analyze code for potential bugs, security vulnerabilities, and performance issues.
- Automated Test Generation: Create comprehensive unit tests to ensure your code is robust.
- Smart Commenting: Intelligently add and explain comments to clarify your codebase.
- Effortless Language Conversion: Translate code snippets from one language to another with detailed explanations.
- Conversational AI: Use the interactive follow-up prompt to ask clarifying questions and dive deeper into the AI's suggestions without losing context.
- Visual Diff Tracking: Track your progress. The diff viewer shows a side-by-side comparison of your code before and after any edit, whether it's a manual change or an AI suggestion.
- Session History: Never lose a good idea. The history panel saves your AI interactions, allowing you to revisit previous responses.
- Seamless File Management: Open local files with the click of a button or by simply dragging and dropping them into the app.
- Ironclad Privacy: Everything runs 100% locally. Your code is never sent to a third-party server, ensuring complete confidentiality.
- Developer-Friendly UI: A clean, customizable interface with adjustable editor settings (font size, minimap), tooltips, and a straightforward workflow.
- Node.js (v18 or later recommended)
- Ollama installed and running on your machine.
- At least one model pulled through Ollama (e.g.,
ollama pull codegemma).
-
Clone the repository:
git clone [https://github.com/your-username/basedsyntax.git](https://github.com/your-username/basedsyntax.git) cd basedsyntax -
Install dependencies:
npm install
-
Run the development server:
npm run dev
-
Open your browser and navigate to
http://localhost:5173(or the address provided in your terminal).
- Select a Model: Choose an available Ollama model from the dropdown at the top of the screen.
- Write or Open Code: Write code directly in the editor, paste it in, or use the "Open" button or drag-and-drop to load a local file.
- Choose an Action: Use the buttons below the editor to perform an action on your code (e.g., "Explain", "Refactor", "Find Bugs").
- Review the Output: The AI's response will stream into the output panel on the right. Code suggestions will include "Apply" and "Copy" buttons for easy use.
- Ask a Follow-up: Use the input box at the bottom of the output panel to ask clarifying questions about the generated response.
- View Diffs: The Diff panel tracks your changes in real-time, showing a side-by-side comparison of your code before and after your latest edit.
Contributions are welcome! If you have a feature request, bug report, or want to contribute to the code, please feel free to open an issue or submit a pull request.
This project is open source and available under the MIT License.
If you find BasedSyntax useful, please give it a star on GitHub!