Ouro Ouroboros

git-docs

Overview

Clones a remote repository, synthesises a README-style summary through an agent, and stores the result under .ouro/technologies/. The command keeps the curated docs map in sync so other workflows can rely on the new reference.

Usage

ouro git-docs <package-name> <repository-url> [--agent-model <model>]

Key Options

  • --agent-model <model> – Override the model used to draft the README from the cloned repository.

Inputs & Outputs

  • Inputs: package identifier and repository URL; requires OPENAI_API_KEY for the synthesis step.
  • Outputs: Markdown stored at .ouro/technologies/<package>.md plus an updated .ouro/technologies/MAP.md section linking to the repository.

When to Use

  • Capture documentation straight from a library’s source repository when public docs are sparse.
  • Refresh existing tech notes after major releases.

Follow-up Checklist

  • Review the generated Markdown for licensing or security-sensitive material before committing.
  • Keep the docs map committed alongside the new technology file.