📃 Table of Contents

• Features
• Usage
• API
  • getRepoUrl()
  • getRepoUrlSync()
• Examples
• Changelog
• Support
• License
• Related
• Author

🤖 Features

• ⚡ Async & sync modes - fetch the Git remote URL your way
• 📂 Custom directory - point to any folder, not just the current one
• 🛡 Input validation - blocks invalid or empty paths early
• 🚫 Existence check - errors if the folder doesn't exist
• 🖥 Direct Git command - uses git remote get-url origin for accuracy
• ✅ Clean return - URL string if found, empty string if not
• 🧩 Error‑safe - gracefully handles Git errors without crashing
• 🪶 Lightweight dependency - minimal overhead, fast execution

⚠️ WARNING

This module requires that the git executable is installed and available in the system path.

If not, it needs to be installed first.

🕵🏼 Usage

Install it by executing any of the following, depending on your preferred package manager:

pnpm add @igorskyflyer/git-repo-url

yarn add @igorskyflyer/git-repo-url

npm i @igorskyflyer/git-repo-url

🤹🏼 API

getRepoUrl(options?): Promise<string>

Asynchronously gets the URL of a local directory if it is a Git repository.

options - optional object with options:

• directory - sets the current working directory, otherwise the current directory will be used instead.

Will throw an error if the passed directory is not valid or does not exist.

Returns the URL if the directory is a Git repository, otherwise an empty string.

getRepoUrlSync(options?): string

Synchronously gets the URL of a local directory if it is a Git repository.

options - optional object with options:

• directory - sets the current working directory, otherwise the current directory will be used instead.

Will throw an error if the passed directory is not valid or does not exist.

Returns the URL if the directory is a Git repository, otherwise an empty string.

🗒️ Examples

example.ts

import { getRepoUrlSync } from '@igorskyflyer/git-repo-url'

console.log(getRepoUrlSync()) // prints e.g. 'https://github.com/igorskyflyer/npm-duoscribi'

📝 Changelog

📑 The changelog is available here, CHANGELOG.md.

🪪 License

Licensed under the MIT license which is available here, MIT license.

💖 Support

🧬 Related

@igorskyflyer/recursive-readdir

📖 Provides recursive readdir() and readdirSync() functions. 📁

@igorskyflyer/is-rootdir

🔼 Provides a way to check if the given path is the root drive/directory. ⛔

@igorskyflyer/vscode-folderpicker

✨ Provides a custom Folder Picker API + UI for Visual Studio Code. 🎨

@igorskyflyer/is-git-repo

🐸 Checks if a directory is a local Git repository. 🕶️

@igorskyflyer/regkeys

📚 An npm package for fetching Windows registry keys. 🗝

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).