• Stars
    star
    4
  • Rank 3,256,273 (Top 66 %)
  • Language
    Go
  • License
    MIT License
  • Created about 3 years ago
  • Updated 12 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Create git repository for GitHub style

Version GolangCI-Lint Status Go Build Status codecov

GitHub Friendly Repo Creator/Initializer

Create git repository for GitHub style:

  • README.md (as seen here!)
  • LICENSE (optional, currently MIT only)
  • CODE_OF_CONDUCT.md (optional)
  • .bumpversion.cfg file injection (optional)

Installation

Install from source;

go install github.com/vigo/git-init-githubrepo@latest

or

brew install vigo/git-init-githubrepo/git-init-githubrepo

Usage

You can use with standard git command. -h, --help or help will display help :)

$ git init-githubrepo -h

NAME:
   git-init-githubrepo - create git repository with built-in README, LICENSE and more...

USAGE:
   git-init-githubrepo [global options] command [command options] [arguments...]

VERSION:
   0.2.0

AUTHOR:
   Uğur "vigo" Özyılmazel <[email protected]>

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --bash-completion                  generate bash-completion code (default: false)
   --disable-bumpversion              do not create .bumpversion.cfg and badge to README (default: false)
   --disable-coc                      do not add CODE_OF_CONDUCT (default: false)
   --disable-fork                     do not add fork information to README (default: false)
   --email EMAIL, -e EMAIL            your contact EMAIL (default: "[email protected]")
   --full-name FULLNAME, -f FULLNAME  your FULLNAME (default: "Uğur Özyılmazel")
   --help, -h                         show help (default: false)
   --license LICENSE, -l LICENSE      add LICENSE (default: "mit")
   --list-licenses, --ll              list licenses (default: false)
   --no-license                       do not add LICENSE file (default: false)
   --project-name NAME, -p NAME       NAME of your project
   --repository-name NAME, -r NAME    NAME of your GitHub repository
   --username USERNAME, -u USERNAME   your GitHub USERNAME (default: "vigo")
   --version, -v                      version information (default: false)
   

EXAMPLES:
  
  $ git init-githubrepo -p "My Awesome Project" -r "hello-world"
  $ git init-githubrepo -p "My Awesome Project" -r "hello-world" --disable-fork
  $ git init-githubrepo -p "My Awesome Project" -r "hello-world" --disable-fork --disable-bumpversion
  $ git init-githubrepo -p "My Awesome Project" -r "hello-world" --disable-fork --disable-bumpversion --disable-coc
  $ git init-githubrepo -p "My Awesome Project" -r "hello-world" --disable-fork --disable-bumpversion --disable-coc --no-license

Available license files:

  • mit-na: MIT No Attribution
  • mit: MIT

Command fetches some variables from git configuration as default.

  • --full-name: default is your git config user.name if exists
  • --username: default is your git config github.user if exists
  • --email: default is your git config user.email if exists. Email will be used for CODE_OF_CONDUCT file.
  • --license: default license type is mit.
  • --no-license do not add license information to README and do not create LICENSE file
  • --disable-fork: do not add fork information to README
  • --disable-bumpversion: do not create .bumpversion.cfg file
  • --disable-coc: do not create add code of conduct information README and do not create CODE_OF_CONDUCT file

Required flags are:

  • --project-name: Name of your project (title of your project)
  • --repository-name: The name you gave when creating the project on GitHub (ex: github.com/USERNAME/REPOSITORYNAME)

Let’s start a new project. Let’s cd to /tmp:

$ git init-githubrepo -p "My Awesome Project" -r "hello-world"
your new project is ready at /tmp/hello-world
$ ls -al /tmp/hello-world/
total 16K
drwxr-xr-x  7 vigo wheel  224 Jun 14 13:15 .
drwxrwxrwt 23 root wheel  736 Jun 14 13:15 ..
drwxr-xr-x  9 vigo wheel  288 Jun 14 13:15 .git
-rwxr-xr-x  1 vigo wheel  182 Jun 14 13:15 .bumpversion.cfg
-rwxr-xr-x  1 vigo wheel 3.2K Jun 14 13:15 CODE_OF_CONDUCT.md
-rwxr-xr-x  1 vigo wheel 1.1K Jun 14 13:15 LICENSE.md
-rwxr-xr-x  1 vigo wheel  942 Jun 14 13:15 README.md

For bash-completion add:

eval "$(git-init-githubrepo --bash-completion)"

to your bash profile! (bash completion automatically shipped with brew tap!)


Contributor(s)


Contribute

All PR’s are welcome!

  1. fork (https://github.com/vigo/git-init-githubrepo/fork)
  2. Create your branch (git checkout -b my-feature)
  3. commit yours (git commit -am 'add some functionality')
  4. push your branch (git push origin my-feature)
  5. Than create a new Pull Request!

License

This project is licensed under MIT


This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

More Repositories

1

git-puf-noktalari

Günlük hayatta kullandığımız revizyon kontrol sistemi GIT ile ilgili küçük ipuçlarını anlatan yeni mini kitabım.
Ruby
425
star
2

kommit

Build your commit message without touching or editing your code!
Shell
204
star
3

ruby101-kitap

Türkçe Ruby kitabı
Ruby
197
star
4

dinozorus

1990'lı yıllara damgasını vuran efsane televizyon oyunu Dinozorus. Amiga 1200 - AGA
Assembly
134
star
5

turk-scene-tarihi

80'lerin ortasında başlayan, günümüz bilgisayar kültürünün neredeyse başlangıç noktası olan Türk SCENE/DEMOSCENE tarihçesi
85
star
6

lyk-2017

Linux Yaz Kampı 2017'de anlattığım konular.
41
star
7

django2-project-template

Django project/application starter for lazybones :)
Python
40
star
8

textmate-twitterbootstrap.tmbundle

TextMate bundle for Twitter's Bootstrap
HTML
33
star
9

statoo

`statoo` is a super simple http GET tool for checking site health
Go
32
star
10

awesome-c64

Commodore 64 related links such as C64 tools for Mac/Linux/PC, demoscene related stuff, coding tools, C64 utilities etc...
31
star
11

textmate-octopress.tmbundle

TextMate bundle for Octopress blog engine. http://octopress.org/
29
star
12

gh_issues

Manage GitHub issues from command-line (read only!)
Ruby
22
star
13

dotfiles-light

Just another but `lighter` version of BASH environment
Shell
18
star
14

django-admin-list-filter

Dead simple autocompletion for Django admin `list_filter`.
Python
18
star
15

dotfiles-universal

My old BASH dot-files... Try new one!
Shell
13
star
16

textmate2-python-fmt

Python FMT is a python linter/formatter/checker for TextMate.
Ruby
13
star
17

textmate2-gfm-preview

GitHub Flavored Markdown Preview for TextMate 2
CSS
13
star
18

django-project-template

Project starter for Django 1.11.4 ... Batteries included :)
Python
10
star
19

textmate-hosts.tmbundle

TextMate bundle for /etc/hosts file
9
star
20

dotfiles-fever

Elegant BASH environment for macOS, Ubuntu and Gentoo
Shell
8
star
21

textmate-window-manager

Window manager/arranger for oldskool TextMate (1.5)
Shell
7
star
22

apm-bash-completion

Bash completion for Atom Package Manager (apm)
Shell
6
star
23

stormssh-completion

Bash competion for `sshstorm` (https://github.com/emre/storm)
Shell
6
star
24

devpod

Official website of devPod
HTML
6
star
25

textmate2-ruff-linter

Ruff linter for TextMate2. Linter and auto fixer for python!
Perl
5
star
26

ugur.ozyilmazel.com-v5

Kişisel websitem V4.0
HTML
5
star
27

lsvirtualenvs

Small commandline tool for `virtualenvwrapper`
Go
4
star
28

ghstars

Show GitHub stars count for user!
Go
4
star
29

git-tips

Git versiyon kontrol sistemi ile ilgili Türkçe dökümantasyon ve ipuçları
JavaScript
4
star
30

golang-notlarim

Golang geliştirme ile ilgili aldığım notlar
Ruby
4
star
31

dox2008

2007-2008 yıllarında İstanbul Bilgi Üniversitesi, web departmanı için hazırladığım javascript ve html/css eğitimleri
JavaScript
4
star
32

textmate2-power-tools

Some useful TextMate2 snippets, commands etc...
Ruby
3
star
33

inspect-go

Ruby-ish Object#inspect tryouts for Golang!
Go
3
star
34

putio

Command-Line client for put.io platform (unofficial)
Go
3
star
35

textmate2-tailwind-css

Tailwind CSS support for TextMate 2
Ruby
3
star
36

textmate2-64tass-bundle

64tass Bundle for TextMate 2
2
star
37

sayisal_captcha

Çok basit şekilde iki basamaklı sayılardan random toplama ya da çarpma üreten bir sistem
Ruby
2
star
38

learning-stimulus-02

I'm learning stimulus, this is example 02
JavaScript
2
star
39

vigo

I'm a hustler baby!
2
star
40

textmate2-gomodifytags

TextMate2 implementation of Fatih’s gomodifytags
Shell
2
star
41

vigo.io

Personal website
HTML
2
star
42

els

Unix `ls` command alternative via Ruby :)
Ruby
2
star
43

pg16_django

3. Programlama Günleri / Karabük - Django ile tanışma
Python
2
star
44

ruby101-kitap-kod

Ruby101 kitabında geçen kod örnekleri
2
star
45

learning-stimulus-01

I'm learning stimulus, this is example 01
JavaScript
1
star
46

textmate2-bootstrap3

Bootstrap 3's helpers for TextMate2
1
star
47

uptimerobot_cmd

Command-line client for Uptimerobot service
Ruby
1
star
48

stringutils-demo

A basic golang package for demo purpose only...
Go
1
star
49

textmate1-twitter-bs3.tmbundle

Twitter Bootstrap 3 bundle for TextMate1 (yes the oldest TextMate)
1
star
50

try_git

1
star
51

homebrew-ghstars

Brew tap for ghstars cli
Ruby
1
star
52

homebrew-git-init-githubrepo

brew tap for `git-init-githubrepo`
Ruby
1
star
53

dji18njs

Modified and hardcore changed version of Django's i18n-javascript function. Can be usable as JavasScript Template engine. If you familiar with python's "format text" you will love this!
JavaScript
1
star
54

homebrew-lsvirtualenvs

brew tap for lsvirtualenvs
Ruby
1
star
55

amiga-ascii.tmbundle

Oldskool Amiga ascii/azki/nfo/diz support for TextMate with real Amiga fonts
1
star
56

vigo.github.com

My developer home page...
HTML
1
star
57

my-custom-textmate1-bundle

Many snippets and my custom scratch-pad for TextMate1.
CSS
1
star
58

ugur.ozyilmazel.com

Kişisel web sitem
HTML
1
star
59

textmate-nanorc.tmbundle

.nanorc bundle for TextMate
Ruby
1
star
60

homebrew-statoo

brew tap repo for `statoo`
Ruby
1
star