https://github.com/worlpaker/gitty

Download GitHub File & Directory
https://github.com/worlpaker/gitty

cli cli-app git github github-api go golang golang-cli

Last synced: about 1 month ago
JSON representation

Download GitHub File & Directory

• Host: GitHub
• URL: https://github.com/worlpaker/gitty
• Owner: worlpaker
• License: mit
• Created: 2024-05-01T09:20:07.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T20:07:03.000Z (4 months ago)
• Last Synced: 2024-08-29T21:52:55.178Z (4 months ago)
• Topics: cli, cli-app, git, github, github-api, go, golang, golang-cli
• Language: Go
• Homepage:
• Size: 423 KB
• Stars: 17
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gitty

![GitHub Latest Release](https://img.shields.io/github/v/release/worlpaker/gitty?logo=github)

[![Go](https://github.com/worlpaker/gitty/actions/workflows/go.yml/badge.svg)](https://github.com/worlpaker/gitty/actions/workflows/go.yml)

[![CodeQL](https://github.com/worlpaker/gitty/actions/workflows/codeql.yml/badge.svg)](https://github.com/worlpaker/gitty/actions/workflows/codeql.yml)

[![codecov](https://codecov.io/gh/worlpaker/gitty/graph/badge.svg?token=6T5V3C1IXE)](https://codecov.io/gh/worlpaker/gitty)

[![Go Report Card](https://goreportcard.com/badge/github.com/worlpaker/gitty)](https://goreportcard.com/report/github.com/worlpaker/gitty)

![License](https://img.shields.io/github/license/worlpaker/gitty?logo=github)

![gitty](_examples/gitty.gif)

## Overview

Gitty is a CLI tool that helps you download GitHub files and directories directly! It is fast, simple, and works concurrently. Gitty is easy to use, making it perfect for downloading specific files and folders from large repositories.

## Install

### Go

> Requires **Go 1.22+**

```sh

go install github.com/worlpaker/gitty@latest

```

## Usage

```sh

gitty github-url

```

### Examples

- Download GitHub Directory

```sh

gitty https://github.com/worlpaker/go-syntax/tree/master/examples

```

- Download GitHub File

```sh

gitty https://github.com/worlpaker/go-syntax/blob/master/test/semantic_tokens.go

```

- Gitty also works without the https prefix

```sh

gitty github.com/worlpaker/go-syntax/tree/master/examples

```

## Authorization

GitHub has **hourly** [rate limit](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api):

- For **unauthenticated** users: **60**

- For **authenticated** users: **5000**

- For **enterprise cloud** users: **15000**

Gitty retrieves your GitHub token from your os environment variable with `GH_TOKEN` key. Get your token from [GitHub Personal Tokens](https://github.com/settings/tokens). More details about tokens can be found on [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).

You can set your token manually in your os environment variable with `GH_TOKEN` key, or you can use **gitty**!

- Set token

```sh

gitty -s=your_github_token

```

- Unset token

```sh

gitty -u

```

- Authenticated user info

```sh

gitty -a

```

- Check client auth status and remaninig rate limit

```sh

gitty -c

```

> **NOTE:** Gitty doesn't store your token. It gets, saves, and deletes the token from your os environment variable.

## How it works

Gitty uses [go-github](https://github.com/google/go-github) to interact with GitHub and [cobra](https://github.com/spf13/cobra) for CLI.

## Test

Test coverage is **100%** for Windows, Linux and macOS (see: [gitty test commands](Makefile)).

## Contributing

Yes, please! Feel free to contribute.

## Credits

Inspired by [download-directory](https://github.com/download-directory/download-directory.github.io).

## License

[MIT](LICENSE)