survey

Scan repository manifests and version control to summarize project commands and risks.

2|Updated Feb 18, 2021
One-click install
npx skills add https://github.com/jinyongp/dotfiles --skill survey-jinyongp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: survey
Source: https://github.com/jinyongp/dotfiles/tree/main/agents/skills/survey
Command: npx skills add https://github.com/jinyongp/dotfiles --skill survey-jinyongp

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the guesswork involved in onboarding to a new codebase by automatically generating a high-level map of the project's architecture, commands, and potential risk areas.

Core Features & Use Cases

  • Automated Discovery: Identifies project shape, package managers, and essential build or test commands without manual searching.
  • Risk Assessment: Surfaces potential issues like environment file dependencies, generated artifacts, or complex module boundaries.
  • Use Case: Before starting a new feature in an unfamiliar repository, use this skill to quickly understand the project's layout, how to run tests, and where the core logic resides.

Quick Start

Use the survey skill to map the current directory and provide a summary of the project structure and commands.

Frequently Asked Questions about survey

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is the best way to map a repository structure for onboarding?

Mapping a repository structure for onboarding involves scanning filesystem manifests, package managers, and version control status to produce a concise summary of the project shape, commands, and risks.

How do I identify build and test commands in an unfamiliar codebase?

To identify build and test commands in an unfamiliar codebase, you can use automated discovery tools that scan package managers and filesystem manifests to extract essential operational commands without manual searching.

Do I need standard CLI tools to analyze a project's dependencies and structure?

Yes, you need standard CLI tools like rg and git to analyze a project's dependencies and structure, as they perform the non-destructive inspection of the working directory required to map the architecture.

How does project risk assessment work when scanning a new codebase?

Project risk assessment when scanning a new codebase works by surfacing potential issues like environment file dependencies, generated artifacts, or complex module boundaries that could impact development.

Are there limitations to using automated repository scanning for project planning?

Limitations of automated repository scanning include relying on the presence of standard CLI tools and only performing non-destructive inspection, meaning it may not capture runtime configurations or dynamic dependencies not reflected in the filesystem.