GithubFS
1.0.1
# GithubFS
A provider for powershell which uses octokit to let you use github repos as a filesystem inside powershell
##Usage
Install the `GithubFS` PSModule to a modules directory of your choice, then import it in your profile with
```powershell
ipmo GithubFS
```
Additionally, visit github and grab a [personal access token](https://github.com/settings/tokens). (You
A provider for powershell which uses octokit to let you use github repos as a filesystem inside powershell
##Usage
Install the `GithubFS` PSModule to a modules directory of your choice, then import it in your profile with
```powershell
ipmo GithubFS
```
Additionally, visit github and grab a [personal access token](https://github.com/settings/tokens). (You
# GithubFS
A provider for powershell which uses octokit to let you use github repos as a filesystem inside powershell
##Usage
Install the `GithubFS` PSModule to a modules directory of your choice, then import it in your profile with
```powershell
ipmo GithubFS
```
Additionally, visit github and grab a [personal access token](https://github.com/settings/tokens). (You should
probably give it user and repo permissions) Drop that in your profile like so:
```powershell
$env:GITHUB_TOKEN = '<token>';
```
Great! Now once you refresh your shell you should have access to a `GH:` drive which contains all the orgs/users you
know about! You should be able to use it just like it was a filesystem, however not all applications are capable
of using PSProviders for input paths.
##Detail
The `GithubProvider` project contains a few C# classes used to bind the Github API to a PSProvider and register
the provider.
The `GithubFS` project is a powershell module which loads the `GithubProvider` and, additionally, provides a few
useful cmdlets for manipulating and using the github psprovider.
###Provided Cmdlets
####Out-Github
Is a proxy to `Out-File` which knows about the Github PSProvider and polyfills support for it using `set-content`
to recreate the unavailable stream support. It is aliased to override `Out-File` so that it polyfills support for
shell redirections.
Show more
A provider for powershell which uses octokit to let you use github repos as a filesystem inside powershell
##Usage
Install the `GithubFS` PSModule to a modules directory of your choice, then import it in your profile with
```powershell
ipmo GithubFS
```
Additionally, visit github and grab a [personal access token](https://github.com/settings/tokens). (You should
probably give it user and repo permissions) Drop that in your profile like so:
```powershell
$env:GITHUB_TOKEN = '<token>';
```
Great! Now once you refresh your shell you should have access to a `GH:` drive which contains all the orgs/users you
know about! You should be able to use it just like it was a filesystem, however not all applications are capable
of using PSProviders for input paths.
##Detail
The `GithubProvider` project contains a few C# classes used to bind the Github API to a PSProvider and register
the provider.
The `GithubFS` project is a powershell module which loads the `GithubProvider` and, additionally, provides a few
useful cmdlets for manipulating and using the github psprovider.
###Provided Cmdlets
####Out-Github
Is a proxy to `Out-File` which knows about the Github PSProvider and polyfills support for it using `set-content`
to recreate the unavailable stream support. It is aliased to override `Out-File` so that it polyfills support for
shell redirections.
Installation Options
Owners
Copyright
(c) 2015 . All rights reserved.
Package Details
Author(s)
- Wesley Wigham <wwigham@gmail.com>
Tags
git github psprovider provider filesystem version control
Functions
Dependencies
This module has no dependencies.
FileList
- GithubFS.nuspec
- GithubFS.psd1
- GithubFS.psm1
- GithubFS.pssproj
- GithubFS.test.ps1
- pathinfo.format.ps1xml
- bin\GithubProvider.dll
- bin\GithubProvider.pdb
- bin\Octokit.Caching.dll
- bin\Octokit.dll
- bin\Octokit.pdb
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 1.0.1 (current version) | 6,690 | 5/15/2015 |
| 1.0 | 26 | 5/15/2015 |