gitsome
0.8.0
Integrasi Resmi untuk GitHub dan GitHub Enterprise.
gitsome ?Meskipun baris perintah Git standar adalah alat yang hebat untuk mengelola repo Anda yang didukung Git, mungkin sulit untuk mengingat penggunaan :
Baris perintah Git tidak terintegrasi dengan GitHub , sehingga memaksa Anda untuk beralih antara baris perintah dan browser.
gitsome - CLI Git/GitHub Supercharged Dengan Pelengkapan Otomatis gitsome bertujuan untuk meningkatkan antarmuka git/shell standar Anda dengan berfokus pada:
Tidak semua alur kerja GitHub berfungsi dengan baik di terminal; upaya gitsome untuk menargetkan mereka yang melakukannya.
gitsome menyertakan 29 perintah terintegrasi GitHub yang bekerja dengan SEMUA shell:
$ gh <command> [param] [options]
Jalankan perintah gh bersama dengan Git-Extras dan perintah hub untuk membuka lebih banyak integrasi GitHub!
Anda dapat menjalankan shell opsional :
$ gitsome
untuk mengaktifkan pelengkapan otomatis dan bantuan interaktif untuk hal berikut:
gitsome melengkapi secara otomatis yang berikut ini:
Untuk mengaktifkan pelengkapan otomatis tambahan, lihat bagian Mengaktifkan Penyelesaian Bash.
gitsome mendukung saran otomatis gaya Ikan. Gunakan tombol right arrow untuk menyelesaikan saran.
gitsome didukung oleh xonsh , yang mendukung REPL Python.
Jalankan perintah Python bersama perintah shell:
Fitur xonsh tambahan dapat ditemukan di xonsh tutorial .
gitsome melacak perintah yang Anda masukkan dan menyimpannya di ~/.xonsh_history.json . Gunakan tombol panah atas dan bawah untuk menelusuri riwayat perintah.
Anda dapat mengontrol warna ansi yang digunakan untuk menyorot dengan memperbarui file ~/.gitsomeconfig Anda.
Pilihan warna meliputi:
'black', 'red', 'green', 'yellow',
'blue', 'magenta', 'cyan', 'white'
Jika tidak ada warna, atur nilainya menjadi None . white dapat tampak abu-abu terang di beberapa terminal.
gitsome tersedia untuk Mac, Linux, Unix, Windows, dan Docker.
Tidak semua alur kerja GitHub berfungsi dengan baik di terminal; upaya
gitsomeuntuk menargetkan mereka yang melakukannya.
gitsome baru saja dimulai. Jangan ragu untuk berkontribusi!
gh configuregh create-commentgh create-issuegh create-repogh emailsgh emojisgh feedgh followersgh followinggh gitignore-templategh gitignore-templatesgh issuegh issuesgh licensegh licensesgh megh notificationsgh octogh pull-requestgh pull-requestsgh rate-limitgh repogh reposgh search-issuesgh search-reposgh starredgh trendinggh usergh viewgh configuregh Di Luar gitsomePIL atau PillowPenggunaan:
$ gh <command> [param] [options]
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.
Lihat Referensi Perintah Integrasi GitHub di COMMANDS.md untuk diskusi mendetail tentang semua perintah, parameter, opsi, dan contoh integrasi GitHub.
Lihat bagian selanjutnya untuk referensi cepat .
gitsome Untuk berintegrasi dengan GitHub dengan benar, Anda harus mengonfigurasi gitsome terlebih dahulu :
$ gh configure
Untuk pengguna GitHub Enterprise, jalankan dengan flag -e/--enterprise :
$ gh configure -e
$ gh feed
Lihat umpan aktivitas Anda atau umpan aktivitas pengguna lain, secara opsional melalui pager dengan -p/--pager . Opsi pager tersedia untuk banyak perintah.
$ gh feed donnemartin -p
$ gh feed donnemartin/gitsome -p
$ gh notifications
Lihat semua permintaan penarikan untuk repo Anda:
$ gh pull-requests
Lihat semua terbitan terbuka yang menyebut Anda:
$ gh issues --issue_state open --issue_filter mentioned
Lihat semua masalah, memfilter hanya masalah yang ditetapkan kepada Anda, apa pun statusnya (terbuka, tertutup):
$ gh issues --issue_state all --issue_filter assigned
Untuk informasi selengkapnya tentang filter dan kualifikasi status, kunjungi referensi gh issues di COMMANDS.md.
$ gh starred "repo filter"
Masalah penelusuran yang memiliki +1 terbanyak:
$ gh search-issues "is:open is:issue sort:reactions-+1-desc" -p
Masalah pencarian yang memiliki komentar terbanyak:
$ gh search-issues "is:open is:issue sort:comments-desc" -p
Masalah penelusuran dengan tag "dicari bantuan":
$ gh search-issues "is:open is:issue label:"help wanted"" -p
Masalah pencarian yang nama pengguna Anda diberi tag @donnemartin :
$ gh search-issues "is:issue donnemartin is:open" -p
Cari semua masalah pribadi terbuka Anda:
$ gh search-issues "is:open is:issue is:private" -p
Untuk informasi lebih lanjut tentang kualifikasi kueri, kunjungi referensi masalah pencarian.
Cari semua repo Python yang dibuat pada atau setelah tahun 2015, dengan >= 1000 bintang:
$ gh search-repos "created:>=2015-01-01 stars:>=1000 language:python" --sort stars -p
Untuk informasi lebih lanjut tentang kualifikasi kueri, kunjungi referensi repo pencarian.
Lihat repo yang sedang tren:
$ gh trending [language] [-w/--weekly] [-m/--monthly] [-d/--devs] [-b/--browser]
Lihat dev yang sedang tren (dev saat ini hanya didukung di browser):
$ gh trending [language] --devs --browser
viewLihat notifikasi yang terdaftar sebelumnya, permintaan penarikan, masalah, repo, pengguna, dll, dengan HTML yang diformat dengan baik untuk terminal Anda, atau secara opsional di browser Anda:
$ gh view [#] [-b/--browser]
issueLihat masalah:
$ gh issue donnemartin/saws/1
pull-requestLihat permintaan tarik:
$ gh pull-request donnemartin/awesome-aws/2
.gitignore Daftar semua templat .gitignore yang tersedia:
$ gh gitignore-templates
Siapkan .gitignore Anda:
$ gh gitignore-template Python > .gitignore
LICENSE Daftar semua templat LICENSE yang tersedia:
$ gh licenses
Siapkan atau LICENSE Anda:
$ gh license MIT > LICENSE
Hubungi Octocat untuk mengucapkan pesan yang diberikan atau telur Paskah:
$ gh octo [say]
$ gh user octocat
Lihat profil Anda dengan perintah gh user [YOUR_USER_ID] atau dengan pintasan berikut:
$ gh me
Buat komentar:
$ gh create-comment donnemartin/gitsome/1 -t "hello world"
Buat masalah:
$ gh create-issue donnemartin/gitsome -t "title" -b "body"
Buat repositori:
$ gh create-repo gitsome
Banyak perintah gh mendukung opsi -p/--pager yang menampilkan hasil dalam pager, jika tersedia.
Penggunaan:
$ gh <command> [param] [options] -p
$ gh <command> [param] [options] --pager
Banyak perintah gh mendukung opsi -b/--browser yang menampilkan hasil di browser default Anda, bukan di terminal Anda.
Penggunaan:
$ gh <command> [param] [options] -b
$ gh <command> [param] [options] --browser
Lihat COMMANDS.md untuk daftar detail semua perintah, parameter, opsi, dan contoh integrasi GitHub.
Kesulitan mengingat perintah ini? Lihat pelengkapan otomatis yang praktis dengan bantuan interaktif untuk memandu Anda melalui setiap perintah.
Catatan, Anda dapat menggabungkan gitsome dengan utilitas lain seperti Git-Extras.
gitsome dihosting di PyPI. Perintah berikut akan menginstal gitsome :
$ pip3 install gitsome
Anda juga dapat menginstal gitsome terbaru dari sumber GitHub yang dapat berisi perubahan yang belum diterapkan ke PyPI:
$ pip3 install git+https://github.com/donnemartin/gitsome.git
Jika Anda tidak menginstal di virtualenv , Anda mungkin perlu menjalankannya dengan sudo :
$ sudo pip3 install gitsome
pip3 Tergantung pada pengaturan Anda, Anda mungkin juga ingin menjalankan pip3 dengan -H flag :
$ sudo -H pip3 install gitsome
Bagi sebagian besar pengguna linux, pip3 dapat diinstal di sistem Anda menggunakan paket python3-pip .
Misalnya, pengguna Ubuntu dapat menjalankan:
$ sudo apt-get install python3-pip
Lihat tiket ini untuk lebih jelasnya.
Anda dapat menginstal paket Python di virtualenv untuk menghindari potensi masalah dengan dependensi atau izin.
Jika Anda adalah pengguna Windows atau jika Anda ingin detail lebih lanjut tentang virtualenv , lihat panduan ini.
Instal virtualenv dan virtualenvwrapper :
$ pip3 install virtualenv
$ pip3 install virtualenvwrapper
$ export WORKON_HOME=~/.virtualenvs
$ source /usr/local/bin/virtualenvwrapper.sh
Buat virtualenv gitsome dan instal gitsome :
$ mkvirtualenv gitsome
$ pip3 install gitsome
Jika instalasi pip tidak berhasil, Anda mungkin menjalankan Python 2 secara default. Periksa versi Python yang Anda jalankan:
$ python --version
Jika panggilan di atas menghasilkan Python 2, temukan jalur untuk Python 3:
$ which python3 # Python 3 path for mkvirtualenv's --python option
Instal Python 3 jika diperlukan. Setel versi Python saat memanggil mkvirtualenv :
$ mkvirtualenv --python [Python 3 path from above] gitsome
$ pip3 install gitsome
Jika Anda ingin mengaktifkan kembali gitsome virtualenv nanti, jalankan:
$ workon gitsome
Untuk menonaktifkan gitsome virtualenv , jalankan:
$ deactivate
Anda dapat menjalankan gitsome di container Docker untuk menghindari instalasi Python dan pip3 secara lokal. Untuk menginstal Docker, lihat dokumentasi resmi Docker.
Setelah Anda menginstal buruh pelabuhan, Anda dapat menjalankan gitsome:
$ docker run -ti --rm mariolet/gitsome
Anda dapat menggunakan volume Docker untuk mengizinkan gitsome mengakses direktori kerja Anda, .gitsomeconfig dan .gitconfig lokal Anda:
$ docker run -ti --rm -v $(pwd):/src/
-v ${HOME}/.gitsomeconfig:/root/.gitsomeconfig
-v ${HOME}/.gitconfig:/root/.gitconfig
mariolet/gitsome
Jika Anda sering menjalankan perintah ini, Anda mungkin ingin mendefinisikan alias:
$ alias gitsome="docker run -ti --rm -v $(pwd):/src/
-v ${HOME}/.gitsomeconfig:/root/.gitsomeconfig
-v ${HOME}/.gitconfig:/root/.gitconfig
mariolet/gitsome"
Untuk membuat image Docker dari sumber:
$ git clone https://github.com/donnemartin/gitsome.git
$ cd gitsome
$ docker build -t gitsome .
gitsome Setelah terinstal, jalankan pelengkap otomatis gitsome opsional dengan bantuan interaktif:
$ gitsome
Menjalankan shell gitsome opsional akan memberi Anda pelengkapan otomatis, bantuan interaktif, saran gaya ikan, REPL Python, dll.
ghJalankan perintah terintegrasi GitHub:
$ gh <command> [param] [options]
Catatan: Menjalankan shell gitsome tidak diperlukan untuk menjalankan perintah gh . Setelah menginstal gitsome Anda dapat menjalankan perintah gh dari shell apa pun.
gh configure Untuk berintegrasi dengan GitHub dengan benar, gitsome harus dikonfigurasi dengan benar:
$ gh configure
Jalankan dengan tanda -e/--enterprise :
$ gh configure -e
Lihat detail lebih lanjut di bagian konfigurasi gh.
Secara default, gitsome melihat lokasi berikut untuk mengaktifkan penyelesaian bash.
Untuk menambahkan penyelesaian bash tambahan, perbarui file ~/.xonshrc dengan lokasi penyelesaian bash Anda.
Jika ~/.xonshrc tidak ada, buatlah:
$ touch ~/.xonshrc
Misalnya, jika penyelesaian tambahan ditemukan di /usr/local/etc/my_bash_completion.d/completion.bash , tambahkan baris berikut di ~/.xonshrc :
$BASH_COMPLETIONS.append('/usr/local/etc/my_bash_completion.d/completion.bash')
Anda harus memulai ulang gitsome agar perubahan dapat diterapkan.
gh Di Luar gitsome Anda dapat menjalankan perintah gh di luar pelengkap shell gitsome . Untuk mengaktifkan penyelesaian tab gh untuk alur kerja ini, salin file gh_complete.sh secara lokal.
Beri tahu bash bahwa penyelesaian tersedia untuk perintah gh dalam sesi Anda saat ini:
$ source /path/to/gh_complete.sh
Untuk mengaktifkan penyelesaian tab untuk semua sesi terminal, tambahkan yang berikut ini ke file bashrc Anda:
source /path/to/gh_complete.sh
Muat ulang bashrc Anda:
$ source ~/.bashrc
Kiat: . adalah kependekan dari source , jadi Anda dapat menjalankan ini:
$ . ~/.bashrc
zsh menyertakan modul yang kompatibel dengan penyelesaian bash.
Unduh file gh_complete.sh seperti di atas dan tambahkan yang berikut ke .zshrc Anda :
autoload bashcompinit
bashcompinit
source /path/to/gh_complete.sh
Muat ulang zshrc Anda:
$ source ~/.zshrc
PIL atau Pillow Menampilkan avatar untuk perintah pengguna gh me dan gh user akan memerlukan instalasi ketergantungan PIL atau Pillow opsional.
Windows* dan Mac:
$ pip3 install Pillow
*Lihat bagian Dukungan Windows untuk mengetahui batasan pada avatar.
Pengguna Ubuntu, lihat petunjuk ini di Askubuntu
gitsome didukung oleh xonsh yang saat ini tidak mendukung Python 2.x, seperti yang dibahas dalam tiket ini.
gitsome telah diuji pada Windows 10 dengan cmd dan cmder .
Meskipun Anda dapat menggunakan command prompt Windows standar, Anda mungkin akan memiliki pengalaman yang lebih baik dengan cmder atau conemu.
Perintah gh user dan gh me akan selalu mengaktifkan flag -t/--text_avatar , karena img2txt tidak mendukung ansi avatar di Windows.
Di Windows, file .gitsomeconfig dapat ditemukan di %userprofile% . Misalnya:
C:Usersdmartin.gitsomeconfig
Jika Anda tertarik berkontribusi pada gitsome , jalankan perintah berikut:
$ git clone https://github.com/donnemartin/gitsome.git
$ cd gitsome
$ pip3 install -e .
$ pip3 install -r requirements-dev.txt
$ gitsome
$ gh <command> [param] [options]
pip3 Jika Anda mendapatkan kesalahan saat menginstal yang mengatakan bahwa Anda memerlukan Python 3.4+, itu mungkin karena perintah pip Anda dikonfigurasi untuk versi Python yang lebih lama. Untuk memperbaiki masalah ini, disarankan untuk menginstal pip3 :
$ sudo apt-get install python3-pip
Lihat tiket ini untuk lebih jelasnya.
Detail integrasi berkelanjutan tersedia di Travis CI.
Jalankan pengujian unit di lingkungan Python aktif Anda:
$ python tests/run_tests.py
Jalankan pengujian unit dengan tox di beberapa lingkungan Python:
$ tox
Dokumentasi kode sumber akan segera tersedia di Readthedocs.org. Lihat dokumen sumber.
Jalankan perintah berikut untuk membuat dokumen:
$ scripts/update_docs.sh
Kontribusi dipersilahkan!
Tinjau Pedoman Berkontribusi untuk mengetahui detail tentang cara:
Jangan ragu untuk menghubungi saya untuk mendiskusikan masalah, pertanyaan, atau komentar apa pun.
Info kontak saya dapat ditemukan di halaman GitHub saya.
Saya memberikan kode dan sumber daya dalam repositori ini kepada Anda di bawah lisensi sumber terbuka. Karena ini adalah repositori pribadi saya, lisensi yang Anda terima atas kode dan sumber daya saya berasal dari saya dan bukan perusahaan saya (Facebook).
Copyright 2016 Donne Martin
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
