devonthesofa_obsidian-note-.../scripts/README.md

41 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

## Installation and Usage
1. Install dependencies:
2025-05-25 11:24:28 +00:00
```bash
npm install commander
```
2025-05-25 11:24:28 +00:00
2. Install tsx for executing TypeScript directly:
2025-05-25 11:24:28 +00:00
```bash
npm install -g tsx
```
2025-05-25 11:24:28 +00:00
3. Run the script:
2025-05-25 11:24:28 +00:00
```bash
tsx generate-test-vault.ts --count 40000 --output ./test-vault
```
## Script Options
- `--count` or `-c`: Number of notes to generate (default: 40000)
- `--output` or `-o`: Output directory path (default: ./test-vault)
- `--tag-prefix` or `-t`: Status tag prefix (default: obsidian-note-status)
- `--depth` or `-d`: Maximum folder depth (default: 5)
- `--max-per-folder` or `-m`: Maximum files per folder (default: 200)
- `--no-status` or `-n`: Generate notes without status tags (default: false)
## Performance Considerations
2025-05-25 11:24:28 +00:00
The script creates a realistic vault structure with:
- Multiple folder levels
- Random distribution of notes across folders
- Variety of statuses including single and multiple status notes
- Varied note content length and structure
- Proper frontmatter format matching your plugin's expectations
2025-05-25 11:24:28 +00:00
This will let you test real-world performance issues with your plugin without needing to manually create thousands of notes.