Skip to content

Feature/improve help command #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

jwjohns
Copy link
Contributor

@jwjohns jwjohns commented Feb 24, 2025

Add instructions command for easy access to cursor-tools documentation

Resolves #26

Overview

This PR adds a new instructions command that outputs the complete cursor-tools documentation and command reference. The command is prominently featured in the help output to make it easy for AI agents to discover and use.

Changes

  • Add new instructions command that outputs the cursor-tools documentation
  • Update help text to prominently feature the instructions command in "Quick Start" section
  • Make instructions command discoverable via cursor-tools --help
  • Register help command properly to ensure consistent help system

Example Usage

# Get complete documentation and command reference
cursor-tools instructions

# Save documentation to a file
cursor-tools instructions --save-to=cursor-tools-docs.md

Testing

  • cursor-tools --help shows instructions command prominently
  • cursor-tools instructions outputs complete documentation
  • cursor-tools help instructions shows command-specific help
  • Help system works correctly for all commands

- Add instructions command to output cursor-tools documentation

- Make instructions command prominent in help output

- Update help text to guide users to full documentation

- Register help command properly
@jwjohns
Copy link
Contributor Author

jwjohns commented Feb 24, 2025

since I added this after adding the Xcode command, I inadvertently create a dependency on it. Let me know if I should change that if there are issues with the Xcode pr.

eastlondoner and others added 14 commits February 27, 2025 11:12
- Add getBundleIdentifier method to extract bundle ID from Info.plist or build settings
- Add getAppName method to get app name from Xcode build settings
- Update findAppBundle to use dynamic app name instead of hardcoded 'PapersApp.app'
- Add fallback methods for more reliable app and bundle ID detection
- Improve search logic for DerivedData with multiple strategies

🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
…options

- Add buildPath parameter support to specify custom derived data location
- Add device parameter for specifying exact simulator device name
- Improve build output with optimized flags for faster builds
- Store build path in environment variable for sharing between commands
- Enhance app bundle discovery logic to find .app files in custom locations
- Add better device name parsing and error handling
- Implement option parsing from command line arguments

🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
Added comprehensive documentation for Xcode commands:
- Added buildPath parameter documentation in cursorrules.ts
- Added Xcode Tools section to README.md with command examples and options
- Added Xcode command-specific options in command options section
- Added Xcode command examples section to show proper usage

🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add an “instructions” command that outputs the cursor-tools prompt (from cursorrules.ts)
2 participants