path-reference

Create properly formatted references to paths (files or folders) in a git repository. Use when writing docs that need to link to any path in the repo.

⭐0stars🔀0forks📁View on GitHub🕐Updated Dec 28, 2025

When & Why to Use This Skill

The path-reference skill automates the generation of properly formatted, clickable web URLs and relative paths for files or folders within a Git repository. It supports major platforms including GitHub, GitLab, Bitbucket, and AWS CodeCommit, ensuring that documentation links are accurate, stable, and compatible with Markdown or reStructuredText formats.

Use Cases

  • Technical Documentation: Automatically generate persistent Markdown links to specific source code files or directories when drafting READMEs, API docs, or project manuals.
  • Code Review & Collaboration: Quickly create and share direct web URLs to repository paths during pull request discussions to provide precise context for team members.
  • Developer Onboarding: Build internal knowledge bases and SOPs with stable links to configuration files and project structures, helping new engineers navigate the codebase efficiently.
  • Cross-Platform Linking: Seamlessly generate repository references that work across different hosting providers like GitLab and Bitbucket without manual URL formatting.
namepath-reference
descriptionCreate properly formatted references to paths (files or folders) in a git repository. Use when writing docs that need to link to any path in the repo.

path-reference

Create clickable links to paths in a git repository.

Commands

Get web URL (always use -b default for stable links):

uvx --from git-web-url==1.0.1 gwu url -p $path -b default

Get relative path (for display text):

uvx --from git-web-url==1.0.1 gwu relpath -p $path

Markdown:

[relative/path/to/file.py](https://github.com/user/repo/blob/main/relative/path/to/file.py)

reStructuredText:

`relative/path/to/file.py <https://github.com/user/repo/blob/main/relative/path/to/file.py>`_

Supported Platforms

GitHub, GitLab, Bitbucket, AWS CodeCommit (including enterprise variants)