|
| 1 | +# SpecStory Artifacts Directory |
| 2 | + |
| 3 | +This directory is automatically created and maintained by the SpecStory extension to preserve your AI chat history. |
| 4 | + |
| 5 | +## What's Here? |
| 6 | + |
| 7 | +- `.specstory/history`: Contains auto-saved markdown files of your AI coding sessions |
| 8 | + - Each file represents a separate AI chat session |
| 9 | + - If you enable auto-save, files are automatically updated as you work |
| 10 | + - You can enable/disable the auto-save feature in the SpecStory settings, it is disabled by default |
| 11 | +- `.specstory/.project.json`: Contains the persistent project identity for the current workspace |
| 12 | + - This file is only present if you enable AI rules derivation |
| 13 | + - This is used to provide consistent project identity of your project, even as the workspace is moved or renamed |
| 14 | +- `.specstory/ai_rules_backups`: Contains backups of the `.cursor/rules/derived-cursor-rules.mdc` or the `.github/copilot-instructions.md` file |
| 15 | + - Backups are automatically created each time the `.cursor/rules/derived-cursor-rules.mdc` or the `.github/copilot-instructions.md` file is updated |
| 16 | + - You can enable/disable the AI Rules derivation feature in the SpecStory settings, it is disabled by default |
| 17 | +- `.specstory/.gitignore`: Contains directives to exclude non-essential contents of the `.specstory` directory from version control |
| 18 | + - Add `/history` to exclude the auto-saved chat history from version control |
| 19 | + |
| 20 | +## Valuable Uses |
| 21 | + |
| 22 | +- Capture: Keep your context window up-to-date when starting new Chat/Composer sessions via @ references |
| 23 | +- Search: For previous prompts and code snippets |
| 24 | +- Learn: Meta-analyze your patterns and learn from your past experiences |
| 25 | +- Derive: Keep the AI on course with your past decisions by automatically deriving rules from your AI interactions |
| 26 | + |
| 27 | +## Version Control |
| 28 | + |
| 29 | +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`: |
| 30 | + |
| 31 | +``` |
| 32 | +.specstory/** |
| 33 | +``` |
| 34 | + |
| 35 | +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`: |
| 36 | + |
| 37 | +``` |
| 38 | +.specstory/ai_rules_backups |
| 39 | +``` |
| 40 | + |
| 41 | +## Searching Your Codebase |
| 42 | + |
| 43 | +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. |
| 44 | + |
| 45 | +To exclude AI interaction history: |
| 46 | + |
| 47 | +1. Open the "Find in Files" search in Cursor or VSCode (Cmd/Ctrl + Shift + F) |
| 48 | +2. Navigate to the "files to exclude" section |
| 49 | +3. Add the following pattern: |
| 50 | + |
| 51 | +``` |
| 52 | +.specstory/* |
| 53 | +``` |
| 54 | + |
| 55 | +This will ensure your searches only return results from your working codebase files. |
| 56 | + |
| 57 | +## Notes |
| 58 | + |
| 59 | +- 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. |
| 60 | + |
| 61 | +## Settings |
| 62 | + |
| 63 | +You can control auto-saving behavior in Cursor or VSCode: |
| 64 | + |
| 65 | +1. Open Cursor/Code → Settings → VS Code Settings (Cmd/Ctrl + ,) |
| 66 | +2. Search for "SpecStory" |
| 67 | +3. Find "Auto Save" setting to enable/disable |
| 68 | + |
| 69 | +Auto-save occurs when changes are detected in the sqlite database, or every 2 minutes as a safety net. |
0 commit comments