playbooks

home / skills / robzolkos / zolkos-agent-skills / prime

prime skill

/skills/prime

This skill inventories a codebase by listing tracked files and summarizing README contents to quickly understand project scope.

npx playbooks add skill robzolkos/zolkos-agent-skills --skill prime

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
309 B
---
name: prime
description: Prime yourself on a codebase by listing files and reading the README.
disable-model-invocation: true
allowed-tools: Bash(git *), Read
---

# Prime
Execute the following sections to understand the codebase then summarize your understanding.

## Run
git ls-files

## Read
README.md

Overview

This skill helps you quickly prime yourself on a codebase by listing tracked files and reading the repository README. It gives a fast, focused snapshot so you can form an initial mental model and plan next exploration steps. Use it when you need context before making changes or answering questions about the project.

How this skill works

The skill runs a file listing (git ls-files) to capture all files tracked in the repo, providing a complete view of the codebase surface. It then reads the README to extract the project's purpose, setup instructions, high-level architecture, and usage guidance. The outputs are summarized to highlight important files, entry points, and immediate follow-ups.

When to use it

  • Onboarding to an unfamiliar repository before coding or reviewing.
  • Preparing to write tests, documentation, or design changes.
  • Triage or scope assessment for bug fixes and feature requests.
  • Answering questions about project structure or how to run the project.
  • Before creating issues, pull requests, or planning work.

Best practices

  • Start by scanning the README for purpose, quick start, and architecture notes.
  • Use the file list to identify top-level directories, build configs, and key entry files.
  • Look for common indicators: package manifests, CI configs, Dockerfiles, and LICENSE.
  • Note files that suggest language or framework even if primary language is unspecified.
  • Follow up by opening the most relevant files (entry points, config, docs) for deeper context.

Example use cases

  • A reviewer lists files and reads the README to decide which modules to inspect for a pull request.
  • An engineer onboarding to a new repo builds a checklist of files to read next (setup, main, config).
  • A support engineer quickly determines how to reproduce an issue using README run instructions.
  • A PM or tech lead assesses repo scope and identifies which teams should be involved.
  • An automation agent primes itself to answer user questions about repository layout and setup.

FAQ

What does git ls-files show me?

It lists all files tracked by Git in the repository, giving an accurate view of the codebase contents under version control.

What if the README is outdated or missing?

Treat README clues cautiously. Use the file list to find build configs, manifests, or example scripts to infer current behavior and follow up by opening those files directly.