GitHub CLI adalah alat sumber terbuka (open source) untuk menggunakan GitHub langsung dari baris perintah komputer Anda. Saat bekerja dari baris perintah, Anda bisa memanfaatkan GitHub CLI untuk menghemat waktu dan menghindari berpindah-pindah konteks.
Prasyarat
- Pasang GitHub CLI di macOS, Windows, atau Linux. Untuk informasi lebih lanjut, lihat bagian Installation di repositori GitHub CLI.
- Untuk melakukan autentikasi ke GitHub, jalankan perintah berikut dari terminal Anda: gh auth login
- Pilih lokasi tempat Anda ingin melakukan autentikasi:
- Jika Anda mengakses GitHub di GitHub.com, pilih GitHub.com.
- Jika Anda mengakses GitHub di domain lain, pilih Other, lalu masukkan nama host Anda (misalnya:
octocorp.ghe.com).
- Ikuti petunjuk selanjutnya yang muncul di layar. GitHub CLI akan otomatis menyimpan kredensial Git Anda saat Anda memilih HTTPS sebagai protokol pilihan untuk operasi Git, dan menjawab “yes” pada prompt yang menanyakan apakah Anda ingin melakukan autentikasi ke Git menggunakan kredensial GitHub Anda. Ini berguna karena memungkinkan Anda menggunakan perintah Git seperti
git pushdangit pulltanpa perlu menyiapkan credential manager terpisah atau menggunakan SSH.
Beberapa Perintah yang Berguna
Catatan: Saat Anda menggunakan beberapa perintah untuk pertama kali — misalnya
gh codespace SUBCOMMAND— Anda akan diminta untuk menambahkan scope tambahan pada token autentikasi Anda. Ikuti instruksi yang muncul di layar.
Melihat status Anda
Ketik gh status untuk melihat detail pekerjaan Anda saat ini di GitHub, mencakup seluruh repositori yang Anda ikuti (subscribe).
Melihat sebuah repositori
Ketik gh repo view OWNER/REPO untuk melihat deskripsi repositori beserta file README.md-nya. Ketik gh repo view OWNER/REPO --web untuk membuka repositori tersebut di peramban (browser) default Anda.
Jika Anda menjalankan subperintah repo dari dalam direktori repositori Git lokal yang memiliki remote di GitHub, Anda bisa menghilangkan OWNER/REPO.
Mengkloning sebuah repositori
Ketik gh repo clone OWNER/REPO. Sebagai contoh, gh repo clone octo-org/octo-repo akan mengkloning repositori octo-org/octo-repo ke direktori tempat Anda menjalankan perintah ini di komputer lokal Anda.
Membuat sebuah repositori
Ketik gh repo create lalu ikuti instruksi di layar. Anda dapat membuat repositori baru yang kosong di GitHub, kemudian (jika mau) mengkloningnya secara lokal. Sebagai alternatif, Anda juga bisa mendorong (push) repositori lokal yang sudah ada ke GitHub, dan menjadikannya sebagai remote untuk repositori lokal Anda.
Bekerja dengan issue
Ketik gh issue list --repo OWNER/REPO untuk menampilkan daftar issue yang baru dibuat dan masih terbuka (open) untuk repositori yang ditentukan. Jika Anda menjalankan subperintah issue dari dalam direktori repositori Git lokal yang memiliki remote di GitHub, Anda bisa menghilangkan --repo OWNER/REPO. Misalnya, ketik gh issue list --assignee "@me" untuk menampilkan issue yang ditugaskan kepada Anda di repositori ini, atau gh issue list --author monalisa untuk menampilkan issue yang dibuat oleh pengguna “monalisa”.
Anda juga dapat membuat issue baru maupun mencari issue tertentu.
Bekerja dengan pull request
Ketik gh pr list --repo OWNER/REPO untuk menampilkan daftar pull request yang baru dibuat dan masih terbuka untuk repositori yang ditentukan. Jika Anda menjalankan subperintah pr dari dalam direktori repositori Git lokal yang memiliki remote di GitHub, Anda bisa menghilangkan --repo OWNER/REPO. Misalnya, ketik gh pr list --author "@me" untuk menampilkan pull request terbuka yang Anda buat di repositori ini.
Ketik gh pr list --label LABEL-NAME untuk menampilkan pull request terbuka dengan label tertentu. Ketik gh search prs --review-requested=@me --state=open untuk menampilkan pull request yang diminta untuk Anda tinjau (review).
Untuk membuat pull request, ketik gh pr create dan ikuti instruksi di layar.
Bekerja dengan codespaces
Untuk membuat codespace baru, ketik gh codespace create dan ikuti instruksi di layar.
Untuk menampilkan codespace yang sudah ada, ketik gh codespace list. Untuk membuka codespace di versi web VS Code, ketik gh codespace code -w lalu pilih sebuah codespace.
Pada semua perintah di atas, Anda bisa mengganti codespace dengan cs.
Mendapatkan bantuan
Ketik gh untuk melihat kembali perintah-perintah utama GitHub CLI yang bisa Anda gunakan, misalnya issue, pr, repo, dan sebagainya.
Untuk setiap perintah maupun setiap subperintah turunannya, Anda bisa menambahkan flag --help untuk mengetahui cara penggunaannya. Sebagai contoh, gh issue --help atau gh issue create --help.
Menyesuaikan GitHub CLI
Anda dapat mengubah pengaturan konfigurasi serta menambahkan alias atau ekstensi, agar GitHub CLI bekerja sesuai dengan kebutuhan Anda.
- Ketik
gh config set SUBCOMMANDSuntuk mengatur konfigurasi GitHub CLI, dengan menggantiSUBCOMMANDSsesuai pengaturan yang ingin Anda sesuaikan. Misalnya, Anda dapat menentukan editor teks yang digunakan ketika sebuah perintah GitHub CLI mengharuskan Anda menyunting teks — seperti saat menambahkan isi (body) untuk issue baru yang sedang Anda buat. Untuk mengatur editor teks pilihan Anda ke Visual Studio Code, ketikgh config set editor "code -w". Flag-w(atau--wait) pada contoh ini membuat perintah menunggu hingga file ditutup di Visual Studio Code sebelum melanjutkan langkah berikutnya di terminal Anda. - Definisikan alias untuk perintah yang sering Anda jalankan. Misalnya, jika Anda menjalankan
gh alias set prd "pr create --draft", maka Anda dapat menjalankangh prduntuk membuka draft pull request dengan cepat. - Buat atau tambahkan perintah khusus (custom commands) dengan ekstensi GitHub CLI.
Menggunakan GitHub CLI dengan beberapa akun
Jika Anda memiliki beberapa akun pada platform GitHub yang sama, seperti GitHub.com, Anda dapat melakukan autentikasi ke masing-masing akun dan berpindah di antaranya menggunakan perintah gh auth switch.
Jika Anda perlu menggunakan GitHub CLI di beberapa platform GitHub yang berbeda — misalnya akun pribadi di GitHub.com dan akun pengguna terkelola (managed user account) di GHE.com — lihat dokumentasi tentang penggunaan GitHub CLI lintas platform GitHub.
