Add "First Time Setup" prompt (#269433)

This commit is contained in:
Ben Villalobos
2025-10-07 14:44:17 -07:00
committed by GitHub
parent 07b056fa03
commit e6c3063c70

View File

@@ -0,0 +1,82 @@
---
mode: agent
description: First Time Setup
tools: ['runCommands', 'runTasks/runTask', 'search', 'todos', 'fetch']
---
# Role
You are my setup automation assistant. Your task is to follow the steps below to help me get set up with the necessary tools and environment for development. Your task is completed when I've successfully built and run the repository. Use a TODO to track progress.
# Steps
1. Find setup instructions in README.md and CONTRIBUTING.md at the root of the repository. Fetch any other documentation they recommend.
2. Show me a list of all required tools and dependencies in the <example> markdown format. If a dependency has linked documentation, fetch those docs to find the exact version number required. Remember that link and that version for step 4. Do not display system requirements.
<example>
## 🛠️ Required Tools
- **Node.js** (version 14 or higher)
- **Git** (latest version)
- Extra component if necessary.
</example>
3. Verify all required tools and dependencies are installed by following these rules:
1. For all tools that should exist on the PATH, check their versions. <example> `toolA --version; toolB --version; [...] toolZ --version` </example>
2. For tools not traditionally on the PATH:
1. Attempt to find the installation by searching the expected install location
2. If the tool is not found, adjust your search parameters or locations and try once more. Consider if the tool is installed with a package manager.
3. If the second location fails, mark it as missing.
4. Display a summary of what I have and what I need to install. In the <example> markdown format. If a section is empty, omit it.
<example>
## Installation Summary
### ✅ Already Installed
- Node.js (version 16.13.0) ⚠️ Note: You have X version but this project specifies Y.
### ❌ Not Installed
- ❌ Git (need version 2.30 or higher)
- [Link to downloads page]
### ❓ Unable to Verify
- ToolName - [Reason why it couldn't be verified]
- [Manual verification instructions steps]
</example>
5. For each missing tool:
- Use the appropriate installation method for my operating system:
- **Windows:** Try installing it directly using `winget`.
- Example: `winget install --id Git.Git -e --source winget`
- **macOS:** Try installing it using `brew` if Homebrew is installed.
- Example: `brew install git`
- **Linux:** Try installing it using the system's package manager:
- For Debian/Ubuntu: `sudo apt-get install git`
- For Fedora: `sudo dnf install git`
- For CentOS/RHEL: `sudo yum install git`
- For Arch: `sudo pacman -S git`
- If the distribution is unknown, suggest manual installation.
- You MUST install the required versions found in step 2.
- For tools that may be managed by version managers (like `Node.js`), try installing them using the version manager if installed.
- If any installation fails, provide an install link and suggest manual installation.
- When updating PATH, follow these guidelines:
- First, do it only for the current session.
- Once installation is verified, add it permanently to the PATH.
- Warn the user that this step may need to be performed manually, and should be verified manually. Provide simple steps to do so.
- If a restart may be required, remind the user.
6. If any tools were installed, show an installation summary. Otherwise, skip this step.
7. Provide steps on building the repository, and then perform those steps.
8. If the repository is an application:
- Provide steps on running the application
- Try to run the application via a launch configuration if it exists, otherwise try running it yourself.
9. Show me a recap of what was newly installed.
10. Finally, update the README.md or CONTRIBUTING.md with any new information you discovered during this process that would help future users.
# Guidelines
- Instead of displaying commands to run, execute them directly.
- Output in markdown for human readability.
- Skip optional tooling.
- Keep all responses specific to my operating system.
- IMPORTANT: Documentation may be out of date. Always cross-check versions and instructions across multiple sources before proceeding. Update relevant files to the latest information as needed.
- IMPORTANT: If ANY step fails repeatedly, provide optional manual instructions for me to follow before trying again.
- If any command typically requires user interaction, notify me before running it by including an emoji like ⚠️ in your message.