Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/8LWXpg/PowerToysRun-GitHubRepo

PowerToys Run Plugin to search and open GitHub repositories
https://github.com/8LWXpg/PowerToysRun-GitHubRepo

powertoys powertoys-run powertoys-run-plugin

Last synced: 2 months ago
JSON representation

PowerToys Run Plugin to search and open GitHub repositories

Host: GitHub
URL: https://github.com/8LWXpg/PowerToysRun-GitHubRepo
Owner: 8LWXpg
License: mit
Created: 2024-01-23T12:02:22.000Z (12 months ago)
Default Branch: master
Last Pushed: 2024-07-25T06:29:47.000Z (6 months ago)
Last Synced: 2024-08-04T01:11:18.157Z (6 months ago)
Topics: powertoys, powertoys-run, powertoys-run-plugin
Language: C#
Homepage:
Size: 1.49 MB
Stars: 28
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-powertoys-run-plugins - GitHubRepo - Open GitHub repositories. (Plugins)

README

# GitHubRepo Plugin for PowerToys Run

This is a plugin for [PowerToys Run](https://aka.ms/PowerToysOverview_PowerToysRun) that allows to search for GitHub repositories then open in your default browser.

Checkout the [Template](https://github.com/8LWXpg/PowerToysRun-PluginTemplate) for a starting point to create your own plugin.

## Features

### Search repo with query: `query`

![Search repo with query](./assets/repo.png)

### Search repo with user: `user/repo`

![Search repo with user](./assets/user.png)

### Search repo with default user: `/repo`

If authtoken is set, it will list all the repositories the token has access to. Otherwise,
it will list all the public repositories of the default user.
![Search repo with default user](./assets/default_user.png)

### Context menu

- **Open issues**: Open the issues page of the repository Ctrl+I.
- **Open pull requests**: Open the pull requests page of the repository Ctrl+P.
- **Copy link**: Copy the repository link to clipboard Ctrl+C.

### Settings

- **Default user**: The default user to search for when typed `/`.
- **GitHub auth token** (optional): The GitHub auth token to use for better rate limiting and access to private repo.
You can generate a fine-grained token with read access to metadata. Detailed instructions
[here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token).
![token](./assets/token.png)

## Installation

### Manual

1. Download the latest release of the from the releases page.
2. Extract the zip file's contents to `%LocalAppData%\Microsoft\PowerToys\PowerToys Run\Plugins`
3. Restart PowerToys.

### Via [ptr](https://github.com/8LWXpg/ptr)

```shell
ptr add GitHubRepo 8LWXpg/PowerToysRun-GitHubRepo
```

## Usage

1. Open PowerToys Run (default shortcut is Alt+Space).
2. Type `gr` followed by your search query.
3. Select a search result and press `Enter` to open it in browser.

## Building

1. Clone the repository and the dependencies in `/lib` with `GitHubRepo/copyLib.ps1`.
2. run `dotnet build -c Release`.

## Debugging

1. Clone the repository and the dependencies in `/lib` with `GitHubRepo/copyLib.ps1`.
2. Build the project in `Debug` configuration.
3. Make sure you have [gsudo](https://github.com/gerardog/gsudo) installed in the path.
4. Run `debug.ps1` (change `$ptPath` if you have PowerToys installed in a different location).
5. Attach to the `PowerToys.PowerLauncher` process in Visual Studio.

## Contributing

### Localization

If you want to help localize this plugin, please check the [localization guide](./Localizing.md)