AI SummaryCursor Rules for tonkbook that guide AI agents in building data processing pipelines and workspace structures using the Tonk framework. Useful for developers building conversational data platforms with CLI-driven workflows.
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to add the "tonkbook — Cursor Rules" prompt rules to my project. Repository: https://github.com/tonk-labs/tonkbook Please read the repo to find the rules/prompt file, then: 1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type) 2. If there's an existing rules file, merge the new rules in rather than overwriting 3. Confirm what was added
Description
Cursor Rules for tonkbook
Proper FileListener Usage:
• Import the FileListener: Use import { FileListener, createAndStartFileListener } from "./listeners/fileListener"; • Define your data transformation: Create a transformer function that converts file content to your desired format • Define path transformation: Create a function that maps file paths to keepsync document paths • Define data mapper: Create a mapper function that handles how the transformed data gets written to keepsync • Use the pattern: Initialize the FileListener with your configuration
Use Cases
A workspace is ideal for: • Building personal knowledge management systems • Creating data analysis and visualization dashboards • Developing interactive tools for research and exploration • Prototyping applications that need to process and display complex data • Building systems that combine automation (workers) with human interaction (views) The workspace concept transforms traditional development from static code creation into dynamic, agent-assisted system building where the boundary between tool and user becomes fluid.
What is a Workspace?
A workspace is a structured development environment designed to function as an exocortex or second brain - a conversational data platform where users describe their data needs in natural language, and a coding agent materializes the technical solution. It serves as a comprehensive platform where you can pull data from various sources, run it through processing workflows, and visualize results through React applications.
Workspace Structure
A workspace follows a specific organizational structure with four main directories: • /console — A React app that provides a file browser showing document state in keepsync stores, plus a worker tab with up-to-date information on which workers have run, when they ran, and what data was moved • /instructions — Contains instructions and guidelines for coding agents. Instructions are co-located with functionality: project-level instructions in /instructions/, view-specific guidance in /views/llms.txt, worker patterns in /workers/llms.txt, etc. • /views — Storage location for Tonk apps (or views) created using tonk create. These are interactive React applications that visualize data and provide user interfaces • /workers — Contains Tonk workers created with tonk create. These handle background processing, data ingestion, transformation, and can listen to keepsync stores or file systems for automated workflows
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster
Works With
Any AI assistant that accepts custom rules or system prompts