chore: update README and CLI usage for cursor_gen, version bump to 1.0.1

- Changed CLI usage instructions from `dart run cursor_gen` to `cursor_gen` for global activation.
- Updated project-brief.yaml example and README to reflect new command usage.
- Added app_context section in project-brief.yaml for theme variants and RBAC roles.
- Fixed bundled template resolution for local and global installs to prevent 'Template not found' errors.
- Version bump to 1.0.1 with corresponding updates in CHANGELOG and pubspec.yaml.
This commit is contained in:
2026-05-13 12:08:52 +05:30
parent b05cdb7fbe
commit 54c66efe9b
157 changed files with 8233 additions and 570 deletions
+34 -17
View File
@@ -54,21 +54,37 @@ flutter-cursor-gen/
## Quick Start
### 1. Add to your Flutter project
### 1. Install the CLI globally
```yaml
# pubspec.yaml (dev dependency)
dev_dependencies:
cursor_gen:
git:
url: https://github.com/company/flutter-cursor-templates
path: generator
From pub.dev:
```bash
dart pub global activate cursor_gen
```
From this repository:
```bash
cd flutter-cursor-templates/generator
dart pub global activate --source path .
```
From Git:
```bash
dart pub global activate --source git https://github.com/company/flutter-cursor-templates --git-path generator
```
If `cursor_gen` is not found after activation, add Dart's global bin directory to your shell:
```bash
export PATH="$PATH":"$HOME/.pub-cache/bin"
```
### 2. Create your brief (interactive wizard)
```bash
dart run cursor_gen --wizard
cursor_gen --wizard
```
Or copy the single reference brief (every option is explained in comments):
@@ -80,7 +96,8 @@ cp path/to/flutter-cursor-gen/example-project/project-brief.yaml .
### 3. Generate your .cursor/ directory
```bash
dart run cursor_gen
cursor_gen --validate
cursor_gen
```
### 4. Commit and share with your team
@@ -95,13 +112,13 @@ git commit -m "chore: add cursor AI config for this project"
## All CLI commands
```bash
dart run cursor_gen # First-time setup
dart run cursor_gen --wizard # Interactive brief creator
dart run cursor_gen --validate # Validate brief without generating
dart run cursor_gen --refresh # Re-generate (preserves custom/ + CURSOR:CUSTOM blocks)
dart run cursor_gen --diff # Preview changes before refresh
dart run cursor_gen --check-updates # Check for template version updates
dart run cursor_gen --telemetry # Show usage analytics report
cursor_gen # First-time setup
cursor_gen --wizard # Interactive brief creator
cursor_gen --validate # Validate brief without generating
cursor_gen --refresh # Re-generate (preserves custom/ + CURSOR:CUSTOM blocks)
cursor_gen --diff # Preview changes before refresh
cursor_gen --check-updates # Check for template version updates
cursor_gen --telemetry # Show usage analytics report
```
---