Code Monkey home page Code Monkey logo

gitget's Introduction

gitget

๐Ÿ“ฆ Clone GitHub repos fast and easy.


Usage

Console

# GitHub Repository

# clone to /repo
# (downloads the default branch of user/repo from GitHub)
$ npx gitget user/repo

# clone to /folder
$ npx gitget user/repo folder

# clone subfolder to /folder
$ npx gitget user/repo/subfolder folder

# specify a tag, branch or commit
$ npx gitget user/repo#dev       # branch
$ npx gitget user/repo#v1.2.3    # release tag
$ npx gitget user/repo#1234abcd  # commit hash

# or simply copy and past the url from your browser
# (downloads the subdir "core/conventional-commits/lib" from lerna/lerna#next)
$ npx gitget https://github.com/lerna/lerna/tree/next/core/conventional-commits/lib

# use the flag -i to only download information about the repo
$ npx gitget user/repo -i
# NPM Package

# download npm package
$ npx gitget npm:packageName

# download npm package to /folder
$ npx gitget npm:packageName folder

# use the flag -i to only download information about the package
$ npx gitget npm:packageName -i

Node.js

interface GitGetOption {
  user?: string
  repo?: string
  folder?: string
  subdir?: string
  /** specify a tag, branch or commit */
  branch?: string
  test?: boolean
  /** silences steps (errors are still displayed) */
  silent?: boolean
  /** npm package name */
  npm?: string
  /** download only information instead */
  info?: boolean
}
// index.cjs
const { gitget } = require('gitget')

gitget({ GitGetOptions })
// index.mjs
import { gitget } from 'gitget/lib/gitget.js'

gitget({ GitGetOptions })
// index.ts
import { gitget } from 'gitget'

gitget({ GitGetOptions })

Try it now!

Download Day.js for example.

# download the repository
$ npx gitget iamkun/dayjs

# download information about the repository
$ npx gitget iamkun/dayjs -i

Use npx gitget@latest ... if something is not working.

License

MIT

gitget's People

Contributors

yandeu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.