Skip to content

Latest commit

 

History

History
105 lines (65 loc) · 3.97 KB

README.md

File metadata and controls

105 lines (65 loc) · 3.97 KB
Raw

PsGithubRepoSnapshot

PowerShell Gallery Version PowerShell Gallery

A Powershell module that integrates with the Github API and downloads a snapshot of all repositories for a user or organisation.

Available in the Powershell Gallery

Requirements

A Github personal access token needs to be created with permissions to access repositories: Github personal access tokens.

Description

Get-GithubRepos

Get a list of repositories from the Github API for a user or organisation. Optionally filter the results.

Uses endpoints:

Github API docs (get repositories for user). Github API docs (get repositories for organisation).

New-GithubRepoSnapshot

Create a snapshot directory containing Github repositories.

Optionally filter repositories by providing a filter type, filter search type and filter text parameters.

Optionally specify which branch to retrieve (the Github repository default branch will be used otherwise).

Optionally supply the ooutput path (C:/temp will beused otherwise).

Hint: Use the Verbose flag to get an informational message written to the host for each repository downloaded.

Installation (from the Powershell Gallery)

Install-Module GithubRepoSnapshot
Import-Module GithubRepoSnapshot

Supplying API credentials

Before any of the GithubRepoSnapshot cmdlets can be run, both your host and credentials need to be registered to the current session using the Set-GithubRepoSnapshotCredentials cmdlet, for example:

Set-GithubCredentials -AccountName 'user' -ApiKey 'api_key' -AccountType User

This registers your credentials for the duration of the session. Adding a -StorePermanent switch to the Set-GithubRepoSnapshotCredentials command will create an encrypted file saved on your machine that will obviate the need to set credentials with each new session:

Set-GithubCredentials -AccountName 'user' -ApiKey 'api_key' -AccountType User -StorePermanent

You can remove credentials at any time by using the Remove-GithubRepoSnapshotCredentials cmdlet. To remove a file created using the -StorePermanent switch run the Remove-GithubRepoSnapshotCredentials with a -DeletePermanent switch:

Remove-GithubCredentials -DeletePermanent

Included cmdlets

Credentials

Set-GithubCredentials
Remove-GithubCredentials

Get repositories

Get-GithubRepos

Create snapshot

New-GithubRepoSnapshot

Building the module and importing locally

Build the .NET core solution

dotnet build [Github clone/download directory]\ps-github-repo-snapshot\src\PsGithubRepoSnapshot.sln

Copy the built files to your Powershell modules directory

Remove any existing installation in this directory, create a new module directory and copy all the built files.

Remove-Item "C:\Users\[User]\Documents\PowerShell\Modules\GithubRepoSnapshot" -Recurse -Force -ErrorAction SilentlyContinue
New-Item -Path 'C:\Users\[User]\Documents\PowerShell\Modules\GithubRepoSnapshot' -ItemType Directory
Get-ChildItem -Path "[Github clone/download directory]\ps-github-repo-snapshot\src\PsGithubRepoSnapshotCmdlet\bin\Debug\netcoreapp3.1\" | Copy-Item -Destination "C:\Users\[User]\Documents\PowerShell\Modules\GithubRepoSnapshot" -Recurse

Contribute

Please raise an issue if you find a bug or want to request a new feature, or create a pull request to contribute.