About .cursorrules prompt file
What you can build
ScreenPipe Service Platform: A web-based platform that hosts and integrates with the ScreenPipe application, offering features like automated transcription and analysis services for various industries such as legal, media, and education. It utilizes the ScreenPipe library for continuous screen and audio recording, offering SaaS subscriptions for extended functionalities.
ScreenPipe Plugin Marketplace: An online marketplace where developers can publish and sell their custom plugins (pipes) for ScreenPipe. It supports plugins written in TypeScript and Deno, enabling users to enhance the capabilities of ScreenPipe with additional features like language translation, advanced analytics, and third-party integrations.
Rust & Tauri Development Toolkit: A comprehensive IDE plugin that provides coding assistance for Rust and Tauri development, specifically tailored to projects like ScreenPipe. It includes tools for error handling with
anyhow, manages asynchronous operations withtokio, and integrates channels for concurrency, all with human-readable and machine-efficient code guidelines.NextJS UI Design Framework: A design kit and boilerplate for developers using NextJS with TailwindCSS, TypeScript, and ShadCN. It focuses on creating stunning UIs with the recommended coding style, featuring pixelated and scientific aesthetics, and integrates animations with Framer Motion for fluid interactions.
Open Source Collaboration Hub: A community-driven platform where developers working on open-source projects similar to ScreenPipe can collaborate, share source codes, and get help for niche libraries or specific coding challenges, with a focus on maintaining coding style consistency and modern UI approaches.
Scientific Aesthetic Design Tool: A design application for creating black-and-white themed graphics with a nerdy, pixelated, and scientific look. This tool assists designers in maintaining the aesthetic requirements of the provided coding style guidelines and ensures compatibility with digital applications.
Automated Code Comment Enhancer: A code analysis tool that automatically suggests improvements for Rust code, ensuring it adheres to the ScreenPipe coding practices such as using
anyhowfor errors, employing channels over mutexes, and keeping code human-readable while optimizing for performance.Transcoding and OCR Optimization Library: A specialized library for efficient transcoding and OCR operations that can be used with the ScreenPipe application. It enhances the stability and accuracy of screen content analysis, providing better insights and data extraction for heavy-duty applications.
Benefits
- Cross-platform Rust and Tauri app for screen recording and AI integration, with TS + Deno plugins.
- Logging and UI style mandates lower case, black & white, with pixelated/scientific fonts.
- Rust development guidelines focus on using anyhow, tokio, channels, and human-readable, fast code.
Synopsis
Developers working on the screenpipe project would benefit by creating a robust, cross-platform, screen recording application with OCR, STT, AI integration, leveraging Rust, Tauri, and TypeScript for optimal performance and style.
Overview of .cursorrules prompt
The .cursorrules file outlines guidelines and preferences for coding styles and practices for a developer named Louis, primarily working on an open-source application called Screenpipe. The project involves technologies such as Rust, Tauri, TypeScript, and Deno, supporting macOS, Windows, and Linux. It emphasizes code readability, performance, and stylistic preferences such as maintaining a black and white aesthetic with pixelated fonts. Specific coding conventions are detailed for Rust and NextJS, including using certain libraries and tools, handling errors, logging, and ensuring proper HTML escaping. Overall, this file serves as a guide to maintain consistency and quality in the development process.
