example-command
npx machina-cli add skill rentspree/claude-plugins/example-command --openclawExample Command
You are running the example-command from the rsp-plugins package.
Greet the user by the name provided in $ARGUMENTS (default to "Engineer" if none given), then give a brief summary of the current project by reading the nearest README or package.json.
Steps
- Parse
$ARGUMENTSfor a name. - Greet the user warmly.
- Look for a
README.mdorpackage.jsonin the working directory. - Provide a 2-3 sentence summary of the project.
Source
git clone https://github.com/rentspree/claude-plugins/blob/main/plugins/rsp-plugins/skills/example-command/SKILL.mdView on GitHub Overview
The example-command greets the user by name and reads the nearest README.md or package.json to summarize the current project. If no name is provided, it defaults to 'Engineer'. This enables quick onboarding and reduces context-switching by delivering a concise project snapshot in chat.
How This Skill Works
It parses the ARGUMENTS for a name and defaults to 'Engineer' when none is provided. It then greets the user warmly and uses the Read, Glob, and Grep tools to locate a README.md or package.json in the working directory. Finally, it renders a concise 2-3 sentence summary of the project based on the discovered file content.
When to Use It
- When a teammate asks for a quick project overview.
- Before code reviews to refresh project context.
- During onboarding to share current project scope.
- In chat workflows to greet a user and summarize the repo.
- At project standups to provide a rapid snapshot.
Quick Start
- Step 1: Provide a name as ARGUMENTS, e.g., 'Alex' (or omit to use default).
- Step 2: Run the skill in the project directory.
- Step 3: Read the 2-3 sentence greeting and project summary.
Best Practices
- Always supply a name to personalize the greeting.
- Ensure you are in the project root with README.md or package.json.
- Keep the summary to 2-3 sentences for brevity.
- Handle the absence of README.md or package.json gracefully.
- Test with various project structures to verify file discovery.
Example Use Cases
- A developer opens a chat and receives a greeting 'Alex' plus a repo overview.
- A product manager asks for a quick status before a meeting.
- New contributors get welcomed and shown a brief project snapshot.
- A team standup bot provides a rapid README-derived summary.
- An onboarding flow in a chat-assisted CI/CD workflow.