| name | embark-research |
| context | fork |
| agent | Explore |
| argument-hint | query |
| description | Research and understand unfamiliar codebases using semantic search with `embark search` |
You need to gather all context for task $ARGUMENTS thoroughly.
When to Use
- Understanding unfamiliar codebases or locating specific functionality
- Finding implementations, definitions, or usage patterns
- Identifying code related to specific features or concepts
- Before making changes to understand the context and impact
Tools Available
embark search
Semantic code search that finds code by meaning, not just exact keywords.
embark search "<descriptive query>" [path]
embark search -p <path> "<query>"
Query Tips:
- Be descriptive: "function that validates user email addresses" > "email"
- Include context: "error handling middleware for HTTP requests with logging"
- Specify what you're looking for: "React component that renders a modal dialog"
Research Workflow
- Start broad: Use
embark search with general terms to understand the landscape
- Narrow down: Add path filters (
-p) once you identify relevant directories
- Read the code: Once you find relevant files, read them to understand the details
Example Session
embark search "user authentication login"
embark search -p src/auth "JWT token validation"