Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trossr32/ps-github-repo-snapshot
A Powershell module that integrates with the Github API and downloads a snapshot of all repositories for a user or organisation.
https://github.com/trossr32/ps-github-repo-snapshot
cmdlet github-api net-core-5 powershell powershell-module
Last synced: 20 days ago
JSON representation
A Powershell module that integrates with the Github API and downloads a snapshot of all repositories for a user or organisation.
- Host: GitHub
- URL: https://github.com/trossr32/ps-github-repo-snapshot
- Owner: trossr32
- License: mpl-2.0
- Created: 2021-04-16T19:32:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-20T19:10:55.000Z (10 months ago)
- Last Synced: 2024-01-21T14:44:48.769Z (10 months ago)
- Topics: cmdlet, github-api, net-core-5, powershell, powershell-module
- Language: C#
- Homepage: https://www.powershellgallery.com/packages/GithubRepoSnapshot
- Size: 59.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PsGithubRepoSnapshot
[](https://www.powershellgallery.com/packages/GithubRepoSnapshot)
[](https://www.powershellgallery.com/packages/GithubRepoSnapshot)
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](https://www.powershellgallery.com/packages/GithubRepoSnapshot)
## Requirements
A Github personal access token needs to be created with permissions to access repositories: [Github personal access tokens](https://github.com/settings/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)](https://docs.github.com/en/rest/reference/repos#list-repositories-for-a-user).
[Github API docs (get repositories for organisation)](https://docs.github.com/en/rest/reference/repos#list-organization-repositories).
### 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)
```powershell
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:
```powershell
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:
```powershell
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:
```powershell
Remove-GithubCredentials -DeletePermanent
```
## Included cmdlets
### Credentials
```powershell
Set-GithubCredentials
Remove-GithubCredentials
```
### Get repositories
```powershell
Get-GithubRepos
```
### Create snapshot
```powershell
New-GithubRepoSnapshot
```
## Building the module and importing locally
### Build the .NET core solution
```powershell
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.
```powershell
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.