README.inc.md

Gitty

A client for the GitHub REST API v3, written in Bash.

Installation

A reasonably sane GNU environment is assumed to be at hand. More specifically, you need:

• Bash (of course)
• GNU Coreutils
• GNU grep, sed, awk
• curl
• the jq command-line JSON processor
• Make

To run the test suite, you will need Sam Stephenson's Bash Automated Testing System.

To check for proper programming, you will need ShellCheck.

Configuration

Authentication

The library supports both basic and OAuth authentication.

Basic authentication is supported through the environment variable GITTY_API_BASIC_AUTH, which must contain the username.

OAuth authentication, on the other hand, is supported through the environment variable GITTY_API_OAUTH_TOKEN.

User agent

All API requests MUST include a valid User-Agent header. The library supports a custom header through the environment variable GITTY_USER_AGENT.

Similar Projects

• ok.sh

Implemented Parts

The active links represent implemented parts of the full API.

• Activity

  • Events
  • Event Types & Payloads
  • Feeds
  • Notifications
  • Starring
  • Watching

• Emojis

• Gists

  • Comments

• Git Data

  • Blobs
  • Commits
  • References
  • Tags
  • Trees

• GitHub Apps

  • Installations
  • GitHub Marketplace
  • Permissions
  • Available Endpoints

• Gitignore

• Issues

  • Assignees
  • Comments
  • Events
  • Labels
  • Milestones
  • Timeline

• Licenses

• Meta

• Migration

  • Migrations
  • Source Imports

• Miscellaneous

  • Codes of Conduct
  • Markdown
  • Meta

• Organizations

  • Blocking Users
  • Members
  • Outside Collaborators
  • Webhooks

• Projects

  • Cards
  • Collaborators
  • Columns

• Pull Requests

  • Reviews
  • Review Comments
  • Review Requests

• Rate Limit

• Reactions

  • Commit Comment
  • Issue
  • Issue Comment
  • Pull Request Review Comment
  • Team Discussion
  • Team Discussion Comment

• Repositories

  • Branches
  • Collaborators
  • Comments
  • Commits
  • Community
  • Contents
  • Deploy Keys
  • Deployments
  • Downloads (deprecated)
  • Forks
  • Invitations
  • Merging
  • Pages
  • Releases
  • Statistics
  • Statuses
  • Traffic
  • Webhooks

• Search

  • Repositories
  • Code
  • Commits
  • Issues
  • Users
  • Topics
  • Labels
  • Text match metadata
  • Legacy search

• Teams

  • Discussions
  • Discussion comments
  • Members

• SCIM

• Users

  • Blocking Users
  • Emails
  • Followers
  • Git SSH Keys
  • GPG Keys