DevRunbook-Public/content/playbooks/repository-inventory/playbook.yaml

apiVersion: devrunbook.io/v1alpha1
kind: Playbook
metadata:
  id: repository-understanding.repository-inventory
  slug: repository-inventory
  version: 1.0.0
  title: Repository Inventory and Map
  summary: Build an evidence-based inventory of applications, services, packages, data stores, deployment assets and key relationships
    without changing the repository.
  category: repository-understanding
  tags:
  - architecture
  - inventory
  - onboarding
  lifecycle: reviewed
  riskTier: low
  authors:
  - name: DevRunbook Core Team
  license: MIT
package:
  files:
  - path: prompt.md
    role: template
    digest: true
    exportByDefault: false
  - path: README.md
    role: documentation
    digest: true
    exportByDefault: false
  - path: CHANGELOG.md
    role: changelog
    digest: true
    exportByDefault: false
  - path: examples/minimal.yaml
    role: example
    digest: true
    exportByDefault: false
  - path: evaluations/static-structure.yaml
    role: evaluation
    digest: true
    exportByDefault: false
spec:
  type: guided
  intent:
    problem: Development work around repository inventory and map is often underspecified, inconsistently executed or reported
      without enough evidence.
    outcome: Build an evidence-based inventory of applications, services, packages, data stores, deployment assets and key
      relationships without changing the repository.
    whenToUse:
    - Use this playbook when the repository needs a bounded repository inventory and map task with explicit evidence and completion
      criteria.
    - Use it when Codex should follow a repeatable workflow rather than improvise from a one-line request.
    whenNotToUse:
    - Do not use it when the desired outcome or authority boundaries are still materially undecided.
    - Do not use it to access unavailable production credentials, bypass safeguards or claim validation that cannot be performed.
  modes:
  - inspect
  - plan
  defaultMode: inspect
  autonomy:
    min: observe
    max: diagnose
    default: diagnose
  inputs:
  - key: targetScope
    label: Target scope
    description: Describe the repository areas, modules or boundaries that should be included.
    type: multiline
    required: true
    sensitive: false
    includeInOutput: true
  - key: desiredDepth
    label: Desired depth
    description: Choose how deeply the playbook should investigate the selected scope.
    type: enum
    required: true
    sensitive: false
    includeInOutput: true
    default: standard
    options:
    - focused
    - standard
    - deep
  compatibility:
    repositoryRequired: true
    languages: []
    frameworks: []
    packageManagers: []
    databases: []
    deploymentTypes: []
    requiredProfileCapabilities: []
    incompatibleConditions: []
  guardrails:
  - id: guardrail-1
    severity: blocking
    text: Do not modify repository files, Git state, configuration or external systems.
  - id: guardrail-2
    severity: blocking
    text: Distinguish directly observed components from inferred relationships and state confidence.
  - id: guardrail-3
    severity: blocking
    text: Do not copy large source files into the report; cite concise evidence paths and symbols.
  workflow:
  - id: establish-scope
    title: Establish scope
    instruction: Read repository instructions and define included and excluded roots before collecting evidence.
    required: true
  - id: inventory-assets
    title: Inventory assets
    instruction: Identify applications, services, packages, libraries, data stores, infrastructure and deployment assets.
    required: true
  - id: map-relationships
    title: Map relationships
    instruction: Trace imports, runtime calls, storage dependencies and deployment relationships using evidence.
    required: true
  - id: identify-entrypoints
    title: Identify entry points
    instruction: Locate build, runtime, test and operational entry points and note missing or conflicting instructions.
    required: true
  - id: report-unknowns
    title: Report unknowns
    instruction: Separate confirmed facts, inferences, contradictions and inaccessible areas in the final map.
    required: true
  validation:
    commandRoles: []
    checks:
    - id: check-1
      type: assertion
      description: Every mapped component has at least one evidence path or explicit inference label.
      blocking: true
      evidence: Referenced files, command results or explicit review notes.
    - id: check-2
      type: assertion
      description: Unknowns and conflicting evidence are separated from confirmed architecture.
      blocking: true
      evidence: Referenced files, command results or explicit review notes.
  completion:
    criteria:
    - Repository structure and major components are mapped with evidence paths.
    - Unknowns and conflicting evidence are reported separately.
    - Validation evidence and unresolved limitations are reported honestly.
  failurePolicy:
    onValidationFailure: Investigate failures caused by the current work, repair them when they remain within scope, rerun
      affected validation and report any genuine blocker without claiming success.
    onAmbiguity: Use repository evidence and existing conventions for minor reversible choices. Preserve current behavior
      and stop before any material irreversible decision that the specification does not resolve.
    onMissingContext: Inspect the repository for missing non-sensitive context. Never invent commands, credentials, production
      behavior or validation results; report what remains unavailable.
    onOutOfScopeCause: Explain the evidenced out-of-scope cause, avoid unrelated changes and provide the smallest safe follow-up
      recommendation.
    onExternalDependencyUnavailable: Use an approved local substitute or fixture only when it preserves the behavior under
      test. Otherwise record the blocked validation and do not claim the external path succeeded.
    onUnableToReproduce: Record attempted reproduction, environment and observed evidence. Do not apply speculative production
      changes; provide the narrowest next diagnostic action.
  reporting:
    sections:
    - id: outcome
      title: Outcome
      required: true
      description: State the delivered result or audit conclusion without overstating evidence.
    - id: evidence
      title: Evidence and scope
      required: true
      description: List inspected or changed areas and the evidence supporting the result.
    - id: validation
      title: Validation
      required: true
      description: Report commands, manual checks and their actual outcomes.
    - id: risks
      title: Risks and limitations
      required: true
      description: State residual risk, inaccessible evidence and untested conditions.
    - id: follow-up
      title: Recommended follow-up
      required: true
      description: List the smallest useful next actions or state None.
  template:
    main: prompt.md
    partials: []
  exports:
    prompt: true
    markdown: true
    runPack: false
    agentsSuggestion: false
quality:
  reviewStatus: editorial-reviewed
  testedStacks: []
  knownLimitations:
  - Repository-specific effectiveness depends on the accuracy of the selected profile and the evidence available to Codex.
  evaluationCaseIds:
  - repository-inventory.static-structure