"Context is king. Own the context."
This is a preview version (0.2.0) of an offline-friendly, cross-platform, Git-native desktop tool designed to help developers craft detailed, context-aware prompts for Large Language Models (LLMs) using files from local codebases. It also supports applying file modifications from LLMs back into local files.
- Visual File System Exploration: Navigate and select project files/directories to build LLM context with real-time token counting for individual files and the entire context.
- Context Assembly: Automatically generates XML-formatted context from selected files, including directory structure and (optionally) Git diff information.
- Prompt Engineering: Multiple modes (Architect, Ask, Edit, etc.) to tailor system prompts for various development tasks.
- LLM Response Application: Parse XML-based LLM responses to preview and apply file creations, diffs, or deletions.
- Integrated Git Workflow: View Git status, run terminal test commands, format code, and commit changes inside the tool.
- Token Counting: Utilizes
tiktoken
for accurate token estimates. - Keyboard Navigation and Shortcuts: Optimized for maximum speed of use.
- Cross-Platform: Built with Electron for desktop compatibility (Windows, macOS, Linux).
- Node.js (version 16 or higher)
- Git
-
Clone the repository:
git clone https://github.com/timosaarinen/promptly.git cd promptly
-
Install dependencies:
npm install
-
Build:
npm run build
-
Run the application: The executable version of Promptly will be created in the
release
directory:- Windows: Run the installer (
release/Promptly Setup 0.2.0.exe
) or the unpacked version (release/win-unpacked/Promptly.exe
) - macOS: Run the installer (
release/Promptly-0.2.0.dmg
) or the unpacked version - Linux: Run the AppImage (
release/Promptly-0.2.0.AppImage
) or the unpacked version
- Windows: Run the installer (
- Production mode:
npm run prod
- Run the tool in production mode without building an installer - Development mode:
npm run dev
- Run with Vite development server for hot module replacement (HMR)
Agentic coding assistants and "one-click" AI dev tools promise convenience, but often at the cost of control and transparency.
Promptly is built on a different principle: You decide the context and the prompt that is sent to an LLM.
Modern LLMs are only as good as the context they receive. Black-box tools might automate away prompting, but they often hide the details of what's being sent and how suggestions are derived.
Promptly gives you full, visual control over context assembly and ensures that every edit is visible and auditable before it touches your codebase.
Promptly is for developers who:
- Want to understand and curate what the LLM sees
- Care about auditability and reproducibility of code changes
- Prefer transparent workflows over magical automation
- Want to combine the power of modern LLMs with robust, Git-based development practices
- Stabilize core features and improve error handling
- Provide packaged binary releases for easier installation
- Add Playwright E2E testing suite
- Implement more robust diff algorithms beyond search/replace
- Further integrations and LLM interaction workflows
- Improve keyboard shortcuts and accessibility
For issues, questions, or feature requests, please visit our GitHub Issues page.