An open API service indexing awesome lists of open source software.

https://github.com/basvdberg/cursor-config


https://github.com/basvdberg/cursor-config

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# cursor-config

## Table of contents

- [Layout](#layout)
- [One-time setup](#one-time-setup)
- [1. Clone beside your projects](#1-clone-beside-your-projects)
- [2. Install Cursor skills](#2-install-cursor-skills)
- [3. Enable Git hooks in each consumer repo](#3-enable-git-hooks-in-each-consumer-repo)
- [Manual commands](#manual-commands)
- [Environment](#environment)
- [Related repositories](#related-repositories)

Versioned Cursor automation for the Data Engineering workspace: agent rules, skills, Markdown TOC/structure updaters, `prompts.md` generation, and Git pre/post-commit hooks.

Repository: [github.com/basvdberg/cursor-config](https://github.com/basvdberg/cursor-config) (push this folder after clone).

## Layout

| Path | Purpose |
|------|---------|
| `rules/` | Shared Cursor rules (`.mdc`); single copy only—no per-repo `.cursor/rules` |
| `scripts/` | Python tools and install scripts (`install-cursor.ps1`, `update_markdown_docs.py`, …) |
| `githooks/` | Shared `pre-commit` and `post-commit` hooks for consumer repos |
| `skills/` | Cursor agent skills (`create-skill`, `markdown-toc`, `release-details-updater`, `release-retrospective`, `troubleshooting-error-log`, …) |
| `browser-bookmarks-sync.json` | Paths to Chrome/Brave profiles and the Floccus Git repo |

Consumer repositories keep repo-specific files only, for example `project-structure-external.json` and `project-structure-descriptions.json` at their own roots.

## One-time setup

### 1. Clone beside your projects

```text
Data Engineering 2.0/
cursor-config/
browser-bookmarks-sync/ # private Floccus target (in workspace)
data-solution-2026/
data-engineering-2026/
data-engineering-design-patterns/
```

### 2. Install Cursor skills

From this repository:

```powershell
.\scripts\install-cursor.ps1
```

Links each skill under `%USERPROFILE%\.cursor\skills\` to `skills/` in this repo.

**Rules** stay in `cursor-config/rules/` only. Do not add `.cursor/rules` in consumer repositories. Open the parent workspace (or add the `cursor-config` folder to your Cursor workspace) so agents resolve shared rules from this path.

Re-run after adding a new skill.

### 3. Enable Git hooks in each consumer repo

From the consumer repository root:

```powershell
..\cursor-config\scripts\setup-githooks.ps1 .
```

Or add `.cursor-config.json`:

```json
{
"cursorConfig": "../cursor-config",
"preCommit": "standard"
}
```

Use `"preCommit": "strict"` for naming and marker validation (default for `data-engineering-design-patterns`).

## Manual commands

Run from a **consumer** Git root:

```powershell
$cfg = Resolve-Path ..\cursor-config
python "$cfg\scripts\update_markdown_docs.py" --root (Get-Location)
python "$cfg\scripts\update_markdown_docs.py" --toc-only
python "$cfg\scripts\update_prompts.py" # root prompts.md, or release/details// when release/VERSION exists
python "$cfg\scripts\review_markdown.py" .
```

Browser bookmarks (Chrome + Brave → Floccus via Git):

```powershell
$env:CURSOR_CONFIG_ROOT = $cfg
python "$cfg\scripts\sync_browser_bookmarks.py" --basnas --commit --push
```

Skill wrappers (after `install-skills.ps1`):

```powershell
python $env:USERPROFILE\.cursor\skills\markdown-toc\scripts\update_toc.py
```

## Environment

| Variable | Purpose |
|----------|---------|
| `CURSOR_CONFIG_ROOT` | Absolute path to this repo when it is not a sibling of the consumer |

Git config `cursor.configPath` is set automatically by `setup-githooks`.

## Related repositories

- [Data Solution 2026](https://github.com/basvdberg/data-solution-2026)
- [Data Engineering 2026](https://github.com/basvdberg/data-engineering-2026)
- [Data Engineering Design Patterns](https://github.com/basvdberg/data-engineering-design-patterns)
- [Browser bookmarks sync](https://github.com/basvdberg/browser-bookmarks-sync) (private; Floccus)

## Project structure

- [cursor-config](readme.md)
- Githooks
- Rules
- Skills
- Browser Bookmarks Sync
- [Browser bookmarks sync](skills/browser-bookmarks-sync/SKILL.md)
- Create Design Pattern
- [Create design pattern](skills/create-design-pattern/SKILL.md)
- [{Title}](skills/create-design-pattern/TEMPLATE.md)
- Create Skill
- [Create skill (cursor-config)](skills/create-skill/SKILL.md)
- Basnas Ssh
- [BasNAS SSH (docker and git)](skills/basnas-ssh/SKILL.md)
- Deploy Basnas Container
- Templates
- [Fix admin hostname not resolving](skills/deploy-basnas-container/dns-basnas-setup.md)
- [Examples](skills/deploy-basnas-container/examples.md)
- [NGINX as HTTPS edge on port 443 (local server / QNAP)](skills/deploy-basnas-container/nginx-on-443.md)
- [local server deployment reference](skills/deploy-basnas-container/reference.md)
- [Deploy container service on local server](skills/deploy-basnas-container/SKILL.md)
- [Troubleshooting “Your connection is not private” (*.example)](skills/deploy-basnas-container/troubleshooting-tls.md)
- [local server URL map](skills/deploy-basnas-container/url-map.md)
- Markdown Project Structure
- [Markdown project structure](skills/markdown-project-structure/SKILL.md)
- Markdown Toc
- [Markdown table of contents](skills/markdown-toc/SKILL.md)
- Naming Convention Files Folders
- [Naming convention for files and folders](skills/naming-convention-files-folders/SKILL.md)
- Pretty Color Logging
- [Pretty Color Logging](skills/pretty-color-logging/SKILL.md)
- Release Details Updater
- [Release Details Updater](skills/release-details-updater/SKILL.md)
- Review Markdown Structure
- [Review Markdown structure](skills/review-markdown-structure/SKILL.md)
- Troubleshooting Error Log
- [Examples](skills/troubleshooting-error-log/examples.md)
- [Troubleshooting error reference](skills/troubleshooting-error-log/reference.md)
- [Troubleshooting error log](skills/troubleshooting-error-log/SKILL.md)
- Related repositories
- [Data Engineering 2026](https://github.com/basvdberg/data-engineering-2026) — Course and learning materials
- [Data Engineering Design Patterns](https://github.com/basvdberg/data-engineering-design-patterns) — Design pattern catalogue
- [Data Solution 2026](https://github.com/basvdberg/data-solution-2026) — Data solution proof of concept