Package Exports

go-git-it
go-git-it/dist/module.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (go-git-it) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

go-git-it

Download any repository or subdirectory on GitHub with support for Node.js and the CLI

npx go-git-it <url> [outputDir]

Use cases

# cwd is ~/mydevspace/

npx go-git-it https://github.com/username/repository
# copied remote content to ~/mydevspace/repository

npx go-git-it https://github.com/username/repository/tree/main/folder
# copied remote content to ~/mydevspace/folder

npx go-git-it https://github.com/username/repository/blob/main/folder/file.js
# copied remote content to ~/mydevspace/file.js

The second command argument is the output directory:

npx go-git-it https://github.com/username/repository path/to/outputDir
# copied remote content to path/to/outputDir/repository

Node interface

go-git-it can also run on a Node.js program.

Installation

npm install go-git-it

Usage

import goGitIt from "go-git-it";

// Assume cwd is ~/mydevspace/

await goGitIt("https://github.com/username/repository");
// copied remote content to ~/mydevspace/repository

await goGitIt("https://github.com/username/repository/tree/main/folder");
// copied remote content to ~/mydevspace/folder

await goGitIt(
  "https://github.com/username/repository/blob/main/folder/file.js",
);
// copied remote content to ~/mydevspace/file.js

The second parameter is the output path:

import goGitIt from "go-git-it";

// Assume cwd is ~/mydevspace/

await goGitIt("https://github.com/username/repository", "path/to/outputDir");
// copied remote content to path/to/outputDir/repository

API

goGitIt(url, outputDir?, text?)

url

Type: string

The URL to the path you want to download. If a folder, will download its content as well.

outputDir

Type: string

Custom path to the outputDir (defaults to the working directory)

text

Type: string

Adds a custom text message instead of default config. This option overrides the success message as well.

Features

Progress bar showing download status
Support for downloading entire repositories
Support for downloading specific folders
Support for downloading individual files
Custom output directory support
Custom progress messages

License

MIT (c) Cezar Augusto.