An Official Integration for GitHub and GitHub Enterprise.

gitsome

Why gitsome?

The Git Command Line

Although the standard Git command line is a great tool to manage your Git-powered repos, it can be tough to remember the usage of:

• 150+ porcelain and plumbing commands
• Countless command-specific options
• Resources such as tags and branches

The Git command line does not integrate with GitHub, forcing you to toggle between command line and browser.

gitsome - A Supercharged Git/GitHub CLI With Autocomplete

gitsome aims to supercharge your standard git/shell interface by focusing on:

• Improving ease-of-use
• Increasing productivity

Deep GitHub Integration

Not all GitHub workflows work well in a terminal; gitsome attempts to target those that do.

gitsome includes 29 GitHub integrated commands that work with ALL shells:

$ gh <command> [param] [options]

• Quick reference
• General reference

Run gh commands along with Git-Extras and hub commands to unlock even more GitHub integrations!

Git and GitHub Autocompleter With Interactive Help

You can run the optional shell:

 $ gitsome

to enable autocompletion and interactive help for the following:

• Git commands
• Git options
• Git branches, tags, etc
• Git-Extras commands
• GitHub integration commands

General Autocompleter

gitsome autocompletes the following:

• Shell commands
• Files and directories
• Environment variables
• Man pages
• Python

To enable additional autocompletions, check out the Enabling Bash Completions section.

Fish-Style Auto-Suggestions

gitsome supports Fish-style auto-suggestions. Use the right arrow key to complete a suggestion.

Python REPL

gitsome is powered by xonsh, which supports a Python REPL.

Run Python commands alongside shell commands:

Additional xonsh features can be found in the xonsh tutorial.

Command History

gitsome keeps track of commands you enter and stores them in ~/.xonsh_history.json. Use the up and down arrow keys to cycle through the command history.

Customizable Highlighting

You can control the ansi colors used for highlighting by updating your ~/.gitsomeconfig file.

Color options include:

'black', 'red', 'green', 'yellow',
'blue', 'magenta', 'cyan', 'white'

For no color, set the value(s) to None. white can appear as light gray on some terminals.

Available Platforms

gitsome is available for Mac, Linux, Unix, Windows, and Docker.

TODO

Not all GitHub workflows work well in a terminal; gitsome attempts to target those that do.

• Add additional GitHub API integrations

gitsome is just getting started. Feel free to contribute!

Index

GitHub Integration Commands

• GitHub Integration Commands Syntax
• GitHub Integration Commands Listing
• GitHub Integration Commands Quick Reference
• GitHub Integration Commands Reference in COMMANDS.md
  • gh configure
  • gh create-comment
  • gh create-issue
  • gh create-repo
  • gh emails
  • gh emojis
  • gh feed
  • gh followers
  • gh following
  • gh gitignore-template
  • gh gitignore-templates
  • gh issue
  • gh issues
  • gh license
  • gh licenses
  • gh me
  • gh notifications
  • gh octo
  • gh pull-request
  • gh pull-requests
  • gh rate-limit
  • gh repo
  • gh repos
  • gh search-issues
  • gh search-repos
  • gh starred
  • gh trending
  • gh user
  • gh view
• Option: View in a Pager
• Option: View in a Browser

Installation and Tests

• Installation
  • Pip Installation
  • Virtual Environment Installation
  • Running as a Docker Container
  • Running the gh configure Command
    • For GitHub Enterprise Users
  • Enabling Bash Completions
  • Enabling gh Tab Completions Outside of gitsome
    • For Zsh Users
  • Optional: Installing PIL or Pillow
  • Supported Python Versions
  • Supported Platforms
  • Windows Support
• Developer Installation
  • Continuous Integration
  • Unit Tests and Code Coverage
  • Documentation

Misc

• Contributing
• Credits
• Contact Info
• License

GitHub Integration Commands Syntax

Usage:

$ gh <command> [param] [options]

GitHub Integration Commands Listing

  configure            Configure gitsome.
  create-comment       Create a comment on the given issue.
  create-issue         Create an issue.
  create-repo          Create a repo.
  emails               List all the user's registered emails.
  emojis               List all GitHub supported emojis.
  feed                 List all activity for the given user or repo.
  followers            List all followers and the total follower count.
  following            List all followed users and the total followed count.
  gitignore-template   Output the gitignore template for the given language.
  gitignore-templates  Output all supported gitignore templates.
  issue                Output detailed information about the given issue.
  issues               List all issues matching the filter.
  license              Output the license template for the given license.
  licenses             Output all supported license templates.
  me                   List information about the logged in user.
  notifications        List all notifications.
  octo                 Output an Easter egg or the given message from Octocat.
  pull-request         Output detailed information about the given pull request.
  pull-requests        List all pull requests.
  rate-limit           Output the rate limit.  Not available for Enterprise.
  repo                 Output detailed information about the given filter.
  repos                List all repos matching the given filter.
  search-issues        Search for all issues matching the given query.
  search-repos         Search for all repos matching the given query.
  starred              Output starred repos.
  trending             List trending repos for the given language.
  user                 List information about the given user.
  view                 View the given index in the terminal or a browser.

GitHub Integration Commands Reference: COMMANDS.md

See the GitHub Integration Commands Reference in COMMANDS.md for a detailed discussion of all GitHub integration commands, parameters, options, and examples.

Check out the next section for a quick reference.

GitHub Integration Commands Quick Reference

Configuring gitsome

To properly integrate with GitHub, you must first configure gitsome:

$ gh configure

For GitHub Enterprise users, run with the -e/--enterprise flag:

$ gh configure -e

Listing Feeds

Listing Your News Feed

$ gh feed

Listing A User's Activity Feed

View your activity feed or another user's activity feed, optionally through a pager with -p/--pager. The pager option is available for many commands.

$ gh feed donnemartin -p

Listing A Repo's Activity Feed

$ gh feed donnemartin/gitsome -p

Listing Notifications

$ gh notifications

Listing Pull Requests

View all pull requests for your repos:

$ gh pull-requests

Filtering Issues

View all open issues where you have been mentioned:

$ gh issues --issue_state open --issue_filter mentioned

View all issues, filtering for only those assigned to you, regardless of state (open, closed):

$ gh issues --issue_state all --issue_filter assigned

For more information about the filter and state qualifiers, visit the gh issues reference in COMMANDS.md.

Filtering Starred Repos

$ gh starred "repo filter"

Searching Issues and Repos

Searching Issues

Search issues that have the most +1s:

$ gh search-issues "is:open is:issue sort:reactions-+1-desc" -p

Search issues that have the most comments:

$ gh search-issues "is:open is:issue sort:comments-desc" -p

Search issues with the "help wanted" tag:

$ gh search-issues "is:open is:issue label:\"help wanted\"" -p

Search issues that have your user name tagged @donnemartin:

$ gh search-issues "is:issue donnemartin is:open" -p

Search all your open private issues:

$ gh search-issues "is:open is:issue is:private" -p

For more information about the query qualifiers, visit the searching issues reference.

Searching Repos

Search all Python repos created on or after 2015, with >= 1000 stars:

$ gh search-repos "crea