Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gleich/solar

🛰️ Clone all your starred GitHub repos
https://github.com/gleich/solar

Last synced: about 1 month ago
JSON representation

🛰️ Clone all your starred GitHub repos

Awesome Lists containing this project

README

        

# solar

🛰️ Clone all your starred GitHub repos

![build](https://github.com/gleich/solar/workflows/build/badge.svg)
![test](https://github.com/gleich/solar/workflows/test/badge.svg)
![lint](https://github.com/gleich/solar/workflows/lint/badge.svg)
![release](https://github.com/gleich/solar/workflows/release/badge.svg)

- [solar](#solar)
- [❓ What is solar?](#-what-is-solar)
- [🚀 Install](#-install)
- [🍎 macOS](#-macos)
- [🖥️ Linux and Windows](#️-linux-and-windows)
- [📟 Commands](#-commands)
- [🛰️ `solar download`](#️-solar-download)
- [🙌 Contributing](#-contributing)
- [👥 Contributors](#-contributors)

## ❓ What is solar?

Solar is a command line tool for cloning every repo that your github account has starred (as long as it is public). It is designed for offline use and was created for the [hackclub Zephyr trip](https://zephyr.hackclub.com). It will clone repos under the file format of `./OWNER/NAME`. Besides cloning solar also allows you to search over the cloned repos making it easy to find what you might be looking for. Searching is currently planned for solar version 2.0.

## 🚀 Install

### 🍎 macOS

Simply install via the homebrew homebrew-tap:

```bash
brew install gleich/homebrew-tap/solar
```

### 🖥️ Linux and Windows

You can grab the binary from the [latest release](https://github.com/gleich/solar/releases/latest)

## 📟 Commands

### 🛰️ `solar download`

`solar download` will download all starred repos and will ask you a few questions before running. When it comes to making the PAT (personal access token) you can just create one with no scopes selected.

## 🙌 Contributing

Before contributing please read the [CONTRIBUTING.md file](https://github.com/gleich/solar/blob/master/CONTRIBUTING.md).

## 👥 Contributors

- **[@gleich](https://github.com/gleich)**