Project Narrator

Generate, audit, and maintain a PROJECT-NARRATIVE.md file — a single-source-of-truth document that captures your entire project's architecture, decisions, in...

This skill appears to do what it says: scan a repository, generate a narrative scaffold, and audit it. Before installing or running it: 1) Review the included scripts (they are small and stdlib-only) and run them locally in a safe environment (not a machine with broad network access to sensitive internal services). 2) Avoid running the audit with --check-urls if you don't want the tool to probe URLs referenced in your docs (it will make outbound HTTP requests). 3) Be aware the tool will note where credentials/IDs are stored (paths/names) but not their values; if you don't want those paths documented, remove or sanitize them before running. 4) The tool needs read access to the repo and to run git commands; don't run it with elevated privileges or in environments containing secrets you don't want scanned. If you want higher assurance, run the scripts on a clone of the repo with secrets removed or in an isolated environment.

Type: OpenClaw Skill Name: project-narrator Version: 1.1.0 The project-narrator skill is a comprehensive documentation and auditing tool designed to maintain a 'PROJECT-NARRATIVE.md' file as a single source of truth for a project. It includes two Python scripts, generate.py and audit.py, which scan the workspace for architecture, dependencies, infrastructure, and API routes using standard libraries and git commands. The skill follows security best practices by explicitly instructing the AI agent to avoid including actual secrets and by scanning only example environment files (.env.example). All identified behaviors, such as filesystem scanning and URL reachability checks, are directly aligned with the stated purpose of project documentation and disaster recovery preparation.