@ehubbell/gitty v0.3.7

Overview

The Gitty CLI gives developers an easy way to download Github repositories and subdirectories directly to their local machine. It also lets developers clone Github repositories and subdirectories to their Github account and organizations where they're a member. Depending on the functionality you need, Gitty accepts a variety of options to customize your experience.

Prerequisites

• Github
• Node

Quick Start

npm install -g @ehubbell/gitty
gitty download <repo_url>

Config File

Gitty will look for a .gittyrc config file at the root of your file system containing your platform secrets. To expedite your work, you can use the gitty config to create and / or read that file. You can also pass the --config parameter to any command to specify a different path. For now, Gitty will interpret the following variables:

# ~/.gittyrc

GITHUB_TOKEN=****

Commands

• gitty config
• gitty config --config ~/.gittyenv
• gitty download <repo_url>
• gitty download <repo_url> --path ~/templates/repo-name
• gitty download <repo_url> --unzip --clean --remove
• gitty clone <repo_url> --account <account_login> --name <repo_name>

Development

• git clone
• npm install
• npm start

Scripts

• We've included a couple of helpful scripts for faster development.
• deploy: npm run deploy -- 'commit message'
• publish: npm run publish -- 'commit message' [major|minor|patch]

Testing

• npm run build
• npm pack
• npm install ./npm-package-name.tgz -g
• gitty download <repo_url> --path ~/templates/repo-name

Inspiration

• degit
• gittar

Notes

Feel free to open an issue to discuss changes or submit a PR for bug fixes.