Skip to content

Latest commit

 

History

History
110 lines (67 loc) · 2.96 KB

README.md

File metadata and controls

110 lines (67 loc) · 2.96 KB
Raw

gitty

GitHub Latest Release Go CodeQL codecov Go Report Card License

gitty

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+

go install github.com/worlpaker/gitty@latest

Usage

gitty github-url

Examples

  • Download GitHub Directory
gitty https://github.com/worlpaker/go-syntax/tree/master/examples
  • Download GitHub File
gitty https://github.com/worlpaker/go-syntax/blob/master/test/semantic_tokens.go
  • Gitty also works without the https prefix
gitty github.com/worlpaker/go-syntax/tree/master/examples

Authorization

GitHub has hourly rate limit:

  • 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. More details about tokens can be found on 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
gitty -s=your_github_token
  • Unset token
gitty -u
  • Authenticated user info
gitty -a
  • Check client auth status and remaninig rate limit
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 to interact with GitHub and cobra for CLI.

Test

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

Contributing

Yes, please! Feel free to contribute.

Credits

Inspired by download-directory.

License

MIT