https://github.com/samdenty/github-icons

API, Chrome Extension & Mac App/CLI that adds icons to your repos
https://github.com/samdenty/github-icons

chrome-extension cli extension github icons macos rust sync

Last synced: 1 day ago
JSON representation

API, Chrome Extension & Mac App/CLI that adds icons to your repos

• Host: GitHub
• URL: https://github.com/samdenty/github-icons
• Owner: samdenty
• License: gpl-3.0
• Created: 2022-04-03T18:07:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-05T18:02:41.000Z (over 1 year ago)
• Last Synced: 2024-12-13T18:08:56.329Z (9 days ago)
• Topics: chrome-extension, cli, extension, github, icons, macos, rust, sync
• Language: Rust
• Homepage: https://github-icons.com
• Size: 38.9 MB
• Stars: 243
• Watchers: 18
• Forks: 61
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/samdenty/github-icons)

[![Website demo](assets/api-demo.gif)](https://github-icons.com)

## API Usage

To use the API, generate a token by signing into the website first (click the search bar). A token is required we use the GitHub API, and that is rate limited.

Consider [sponsoring the project](https://github.com/sponsors/samdenty) as it costs to run the API.

```bash

# GitHub Repo icon API:

GET https://github-icons.com/[user]/[repo]?token=[token]

# NPM Package icon API:

GET https://github-icons.com/npm/[package]?token=[token]

# List all icons for a repo:

GET https://github-icons.com/[user]/[repo]/all?token=[token]

# List all icons for a package:

GET https://github-icons.com/npm/[package]/all?token=[token]

```

## Mac APP

### [Download the app](https://github.com/samdenty/github-icons/releases/latest)

Automatically adds project logos to your locally cloned GitHub repos. [Youtube Video](https://www.youtube.com/watch?v=jrO3qSEpAFU)

This repository contains the source code for the github-icons CLI. You can also [sponsor this project](https://github.com/sponsors/samdenty)

## Repo structure

| Folder                                  | Description                                          |

| --------------------------------------- | ---------------------------------------------------- |

| [`api`](/api)                           | Cloudflare worker for fetching repo icons            |

| [`cli`](/cli)                           | CLI for adding repo icons to .git folders            |

| [`chrome-extension`](/chrome-extension) | Chrome extension for adding repo icons to github.com |

| [`vscode-extension`](/vscode-extension) | VSCode extension that adds NPM / GitHub icons        |

| [`repo_icons`](/repo_icons)             | Rust crate for scraping repo icons                   |

| [`website`](/website)                   | The www.github-icons.com website                     |

## Running the CLI

You can run the CLI using the below commands.

```bash

# To install rust

curl https://sh.rustup.rs -sSf | sh

# Clone the repository

git clone https://github.com/samdenty/github-icons

cd github-icons

cargo run -- sync

# or with github token (for private repos)

cargo run -- sync --token INSERT_TOKEN

```

[![Banner](./banner.gif)](https://samddenty.gumroad.com/l/git-icons)