Skip to content

Commit f8468c2

Browse files
committed
fix: address PR review feedback - correct entry point detection and UPDATE.md documentation
- Added missing check for 'Standard input code' in entry point detection to properly handle curl piping - Corrected documentation to accurately describe UPDATE.md as an installation receipt (not version history) - Ensures consistency between documentation and actual implementation Addresses review comments from @gemini-code-assist on PR #13
1 parent f069f25 commit f8468c2

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

CLAUDE.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ cat install.php | php -- --core # Test piped input locally
5353
### Project Organization
5454
- **install.php**: Main installer script (current version defined by CURSOR_RULES_VERSION constant)
5555
- **.cursor/rules/**: Contains 56 MDC rule files organized by category
56-
- **.cursor/UPDATE.md**: Version history file tracking all releases and changes (created by installer)
56+
- **.cursor/UPDATE.md**: Installation receipt file tracking installed version and configuration (created by installer)
5757
- **.tests/**: Bash test scripts for installer validation
5858
- **.github/workflows/**: CI/CD pipeline using GitHub Actions for PHP 8.3
5959
- **AGENTS.md**: Comprehensive guide for using Cursor Rules (created by installer)
@@ -79,29 +79,29 @@ cat install.php | php -- --core # Test piped input locally
7979
2. Script detects if running interactively or with parameters
8080
3. Creates .cursor/rules directory structure
8181
4. Downloads and installs selected rule files from GitHub
82-
5. Creates/updates .cursor/UPDATE.md file to track version history
82+
5. Creates/overwrites .cursor/UPDATE.md file as an installation receipt
8383
6. Creates/updates AGENTS.md documentation (unless --yes flag overwrites)
8484

8585
## Versioning System
8686

8787
### Version Management
8888
- **Version Constant**: Defined in install.php as `CURSOR_RULES_VERSION`
89-
- **Version History**: Tracked in .cursor/UPDATE.md file
89+
- **Version History**: Tracked in GitHub releases and repository documentation
9090
- **Release Process**:
9191
1. Update CURSOR_RULES_VERSION constant in install.php
92-
2. Add version entry to .cursor/UPDATE.md with date and changes
92+
2. Update version history in repository documentation
9393
3. Create GitHub release matching the version number
9494
4. Tag the release in git
9595

9696
### .cursor/UPDATE.md File Purpose
97-
The UPDATE.md file serves as a version history log that:
98-
- Tracks all changes made in each version
99-
- Documents new features, bug fixes, and improvements
100-
- Records the date of each release
101-
- Lists affected files and their impact
102-
- Notes any breaking changes
103-
- Gets created/updated automatically by the installer in user projects
104-
- Helps users understand what changed between versions
97+
The UPDATE.md file serves as an installation receipt that:
98+
- Records the version of cursor-rules that was installed
99+
- Documents the installation date and time
100+
- Lists the number of rule files installed
101+
- Shows the installation type (core, web-stack, Python, etc.)
102+
- Records any tag filters that were applied
103+
- Gets created/overwritten by the installer on each run
104+
- Helps users identify which version and configuration they have installed
105105

106106
## Known Issues and Solutions
107107

install.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -987,7 +987,9 @@ function show_help(): void {
987987
}
988988

989989
// If this script is being run directly, execute the installation.
990-
if (basename(__FILE__) === basename($_SERVER['PHP_SELF'] ?? '')) {
990+
// Also handle execution when piped through curl (PHP_SELF becomes "Standard input code")
991+
if (basename(__FILE__) === basename($_SERVER['PHP_SELF'] ?? '') ||
992+
($_SERVER['PHP_SELF'] ?? '') === 'Standard input code') {
991993
// Default options
992994
$options = [
993995
'debug' => false,

0 commit comments

Comments
 (0)