Function create_git_command

src/gitingest/utils/git_utils.py:256–279

Create a git command with authentication if needed. Parameters ---------- base_cmd : list[str] The base git command to start with. local_path : str The local path where the git command should be executed. url : str The repository URL to check if it's a Gi

(base_cmd: list[str], local_path: str, url: str, token: str | None = None)

def create_git_command(base_cmd: list[str], local_path: str, url: str, token: str | None = None) -> list[str]:
    """Create a git command with authentication if needed.

    Parameters
    ----------
    base_cmd : list[str]
        The base git command to start with.
    local_path : str
        The local path where the git command should be executed.
    url : str
        The repository URL to check if it's a GitHub repository.
    token : str | None
        GitHub personal access token (PAT) for accessing private repositories.

    Returns
    -------
    list[str]
        The git command with authentication if needed.

    """
    cmd = [*base_cmd, "-C", local_path]
    if token and is_github_host(url):
        cmd += ["-c", create_git_auth_header(token, url=url)]
    return cmd


def create_git_auth_header(token: str, url: str = "https://github.com") -> str: