Raincloud/writinRepo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

specstory

Browse Source
This commit is contained in:
Raincloud
2025-05-13 23:48:37 -06:00
parent 0b82ce6f3d
commit f57dee24c0
2 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
# SpecStory explanation file
.specstory/.what-is-this.md

40
.specstory/.what-is-this.md
View File

@@ -1,45 +1,48 @@
# SpecStory Artifacts Directory # SpecStory Artifacts Directory
This directory is automatically created and maintained by the SpecStory extension to preserve your Cursor composer and chat history. This directory is automatically created and maintained by the SpecStory extension to preserve your AI chat history.
## What's Here? ## What's Here?
- `.specstory/history`: Contains markdown files of your AI coding sessions - `.specstory/history`: Contains auto-saved markdown files of your AI coding sessions
- Each file represents a separate chat or composer session - Each file represents a separate AI chat session
- Files are automatically updated as you work - If you enable auto-save, files are automatically updated as you work
- `.specstory/cursor_rules_backups`: Contains backups of the `.cursor/rules/derived-cursor-rules.mdc` file - You can enable/disable the auto-save feature in the SpecStory settings, it is disabled by default
- Backups are automatically created each time the `.cursor/rules/derived-cursor-rules.mdc` file is updated - `.specstory/.project.json`: Contains the persistent project identity for the current workspace
- You can enable/disable the Cursor Rules feature in the SpecStory settings, it is disabled by default - This file is only present if you enable AI rules derivation
- This is used to provide consistent project identity of your project, even as the workspace is moved or renamed
- `.specstory/ai_rules_backups`: Contains backups of the `.cursor/rules/derived-cursor-rules.mdc` or the `.github/copilot-instructions.md` file
- Backups are automatically created each time the `.cursor/rules/derived-cursor-rules.mdc` or the `.github/copilot-instructions.md` file is updated
- You can enable/disable the AI Rules derivation feature in the SpecStory settings, it is disabled by default
## Valuable Uses ## Valuable Uses
- Capture: Keep your context window up-to-date when starting new Chat/Composer sessions via @ references - Capture: Keep your context window up-to-date when starting new Chat/Composer sessions via @ references
- Search: For previous prompts and code snippets - Search: For previous prompts and code snippets
- Learn: Meta-analyze your patterns and learn from your past experiences - Learn: Meta-analyze your patterns and learn from your past experiences
- Derive: Keep Cursor on course with your past decisions by automatically deriving Cursor rules from your AI interactions - Derive: Keep the AI on course with your past decisions by automatically deriving rules from your AI interactions
## Version Control ## Version Control
We recommend keeping this directory under version control to maintain a history of your AI interactions. However, if you prefer not to version these files, you can exclude them by adding this to your `.gitignore`: We recommend keeping this directory under version control to maintain a history of your AI interactions. However, if you prefer not to version these files, you can exclude them by adding this to your `.gitignore`:
``` ```
.specstory .specstory/**
``` ```
We recommend not keeping the `.specstory/cursor_rules_backups` directory under version control if you are already using git to version the `.cursor/rules` directory, and committing regularly. You can exclude it by adding this to your `.gitignore`: We recommend __not__ keeping the `.specstory/ai_rules_backups` directory under version control if you are already using git to version your AI rules, and committing regularly. You can exclude it by adding this to your `.gitignore`:
``` ```
.specstory/cursor_rules_backups .specstory/ai_rules_backups
``` ```
## Searching Your Codebase ## Searching Your Codebase
When searching your codebase in Cursor, search results may include your previous AI coding interactions. To focus solely on your actual code files, you can exclude the AI interaction history from search results. When searching your codebase, search results may include your previous AI coding interactions. To focus solely on your actual code files, you can exclude the AI interaction history from search results.
To exclude AI interaction history: To exclude AI interaction history:
1. Open the "Find in Files" search in Cursor (Cmd/Ctrl + Shift + F) 1. Open the "Find in Files" search in Cursor or VSCode (Cmd/Ctrl + Shift + F)
2. Navigate to the "files to exclude" section 2. Navigate to the "files to exclude" section
3. Add the following pattern: 3. Add the following pattern:
@@ -51,15 +54,14 @@ This will ensure your searches only return results from your working codebase fi
## Notes ## Notes
- Auto-save only works when Cursor/sqlite flushes data to disk. This results in a small delay after the AI response is complete before SpecStory can save the history. - Auto-save only works when Cursor or VSCode flushes sqlite database data to disk. This results in a small delay after the AI response is complete before SpecStory can save the history.
- Auto-save does not yet work on remote WSL workspaces.
## Settings ## Settings
You can control auto-saving behavior in Cursor: You can control auto-saving behavior in Cursor or VSCode:
1. Open Cursor → Settings → VS Code Settings (Cmd/Ctrl + ,) 1. Open Cursor/Code → Settings → VS Code Settings (Cmd/Ctrl + ,)
2. Search for "SpecStory" 2. Search for "SpecStory"
3. Find "Auto Save" setting to enable/disable 3. Find "Auto Save" setting to enable/disable
Auto-save occurs when changes are detected in Cursor's sqlite database, or every 2 minutes as a safety net. Auto-save occurs when changes are detected in the sqlite database, or every 2 minutes as a safety net.