Alat Baris Perintah servbayctl

servbayctl adalah alat baris perintah yang kuat dari ServBay, dirancang untuk memberikan kemampuan kepada pengembang dalam mengelola layanan latar belakang ServBay langsung melalui terminal. Dengan servbayctl, kamu dapat dengan mudah melakukan operasi seperti memulai, menghentikan, me-reload, memulai ulang, membunuh proses, memeriksa status, serta menghentikan semua layanan. Fitur ini sangat berguna bagi otomatisasi skrip, switching cepat status layanan, atau bagi mereka yang lebih menyukai antarmuka baris perintah (CLI).

Dokumen ini akan mengulas secara rinci cara menggunakan servbayctl, daftar perintah yang didukung, parameter, dan layanan yang dapat dikelola.

Gambaran Umum

ServBay tidak hanya menawarkan antarmuka grafis yang intuitif (GUI) untuk mengelola lingkungan pengembangan web lokal, tetapi juga menyediakan tool antarmuka baris perintah (CLI) bernama servbayctl. Alat ini terletak di folder script dalam direktori tempat ServBay diinstal, dan memungkinkan kamu mengontrol berbagai paket perangkat lunak yang diinstal ServBay sebagai layanan latar belakang, hanya dengan perintah sederhana di terminal.

Keuntungan menggunakan servbayctl antara lain:

• Otomatisasi: Mudah diintegrasikan ke dalam skrip workflow pengembangan kamu.
• Efisiensi: Memulai atau menghentikan layanan tertentu dengan cepat tanpa perlu membuka GUI.
• Fleksibel: Cocok digunakan melalui koneksi SSH jarak jauh atau pada lingkungan headless.
• Kontrol Presisi: Dapat menentukan layanan atau versi tertentu untuk dikontrol.

Persyaratan Awal

Sebelum menggunakan servbayctl, pastikan bahwa:

1. Kamu sudah berhasil menginstal ServBay.

2. Kamu memiliki akses ke terminal.

3. (Opsional & Direkomendasikan) Untuk kemudahan penggunaan, tambahkan direktori /Applications/ServBay/script ke variabel PATH lingkungan sistem. Dengan begitu, kamu dapat menjalankan perintah servbayctl dari direktori mana pun tanpa harus mengetikkan path lengkap.

   • Untuk pengguna Bash atau Zsh, edit file ~/.bash_profile, ~/.bashrc, ~/.zshrc, atau ~/.profile dan tambahkan baris berikut:

     export PATH="/Applications/ServBay/script:$PATH"

   • Setelah disimpan, jalankan source ~/.bash_profile (atau file yang diedit) agar perubahan berlaku, atau restart terminal kamu.

Sintaks Penggunaan

Sintaks dasar perintah servbayctl adalah sebagai berikut:

servbayctl <command> <service> [parameters]

• <command>: Operasi yang ingin kamu lakukan (mis: start, stop, restart).
• <service>: Nama layanan yang ingin kamu kelola (mis: php, mysql, caddy).
• [parameters]: Parameter opsional untuk versi layanan atau cakupan (mis: 7.4 atau -all).

Sesuai dengan dokumentasi servbayctl, perintah utama dan struktur dasar penggunaannya adalah sebagai berikut:

Usage: /Applications/ServBay/script/servbayctl {start|stop|reload|restart|kill|status|stop-all} {php|mariadb|mysql|postgresql|redis|memcached|caddy|nginx|apache|dnsmasq|mongodb|rabbitmq|cloudflared|frpc|mailpit|web|ollama} [-all|version]

Catatan: Perintah stop-all tidak menerima nama layanan atau parameter. Ia akan menghentikan semua layanan yang dikelola oleh ServBay.

Penjelasan Lengkap Perintah yang Didukung

Di bawah ini merupakan penjelasan detail untuk setiap perintah yang didukung servbayctl beserta contohnya:

start - Memulai Layanan

Memulai layanan yang ditentukan. Kamu bisa menentukan versi spesifik atau menggunakan parameter -all untuk memulai semua versi yang terpasang dari layanan tersebut.

servbayctl start <service> [-all|version]

• Contoh: Memulai layanan PHP 8.1

  servbayctl start php 8.1

• Contoh: Memulai seluruh versi PHP yang terinstal

  servbayctl start php -all

• Contoh: Memulai layanan MySQL dengan konfigurasi default

  servbayctl start mysql

stop - Menghentikan Layanan

Menghentikan layanan yang ditentukan. Kamu dapat menentukan versi tertentu atau menggunakan -all untuk menghentikan semua versi terpasang.

servbayctl stop <service> [-all|version]

• Contoh: Menghentikan layanan PHP 7.4

  servbayctl stop php 7.4

• Contoh: Menghentikan seluruh versi MariaDB yang terinstal

  servbayctl stop mariadb -all

• Contoh: Menghentikan layanan Redis

  servbayctl stop redis

reload - Memuat Ulang Konfigurasi Layanan

Melakukan reload konfigurasi layanan yang dipilih. Biasanya digunakan setelah kamu mengubah file konfigurasi layanan, agar perubahan langsung berlaku tanpa perlu restart layanan total. Tidak semua layanan mendukung hot reload.

servbayctl reload <service> [-all|version]

• Contoh: Reload konfigurasi server web Caddy

  servbayctl reload caddy

• Contoh: Reload semua versi PHP yang terinstal (jika didukung)

  servbayctl reload php -all

restart - Memulai Ulang Layanan

Me-restart layanan yang dipilih, sama dengan menghentikan kemudian memulai ulang layanan.

servbayctl restart <service> [-all|version]

• Contoh: Restart layanan database PostgreSQL

  servbayctl restart pgsql

• Contoh: Restart seluruh versi Redis yang terinstal (jika ada beberapa versi)

  servbayctl restart redis -all

kill - Memaksa Hentikan Proses Layanan

Memaksa menghentikan proses layanan yang dipilih. Ini adalah metode penghentian paksa yang sebaiknya digunakan hati-hati, karena berpotensi menyebabkan kehilangan atau kerusakan data (terutama untuk layanan database). Biasanya digunakan jika layanan tidak bisa dihentikan secara normal.

servbayctl kill <service> [-all|version]

• Contoh: Memaksa bunuh proses layanan PHP 7.4

  servbayctl kill php 7.4

• Contoh: Memaksa bunuh seluruh proses layanan Memcached

  servbayctl kill memcached -all

status - Melihat Status Layanan

Melihat status terkini dari layanan yang dipilih (apakah sedang berjalan atau tidak).

servbayctl status <service> [-all|version]

• Contoh: Cek status layanan Caddy

  servbayctl status caddy

• Contoh: Cek status seluruh versi MySQL yang terinstal

  servbayctl status mysql -all

stop-all - Menghentikan Semua Layanan ServBay

Menghentikan semua layanan latar belakang yang saat ini dikelola dan sedang berjalan oleh ServBay. Ini adalah perintah global, tidak memakai nama layanan atau parameter versi.

servbayctl stop-all

• Contoh: Hentikan seluruh layanan latar belakang ServBay

  servbayctl stop-all

Daftar Layanan yang Didukung

Berdasarkan informasi penggunaan servbayctl, alat ini bisa langsung mengontrol jenis layanan latar belakang berikut:

• php: Mengelola proses PHP-FPM dari berbagai versi.
• mariadb: Mengelola layanan database MariaDB.
• mysql: Mengelola layanan database MySQL.
• postgresql: Mengelola layanan database PostgreSQL.
• redis: Mengelola layanan cache/database Redis.
• memcached: Mengelola layanan cache Memcached.
• caddy: Mengelola layanan web server Caddy.
• nginx: Mengelola layanan web server Nginx.
• apache: Mengelola layanan web server Apache HTTP.
• dnsmasq: Mengelola layanan DNS internal ServBay.
• mongodb: Mengelola layanan database MongoDB.
• rabbitmq: Mengelola layanan antrian pesan RabbitMQ.
• cloudflared: Mengelola layanan Cloudflare Tunnel (jika telah dipasang/dikonfigurasi).
• frpc: Mengelola layanan klien Fatedier/frp (jika telah dipasang/dikonfigurasi).
• mailpit: Mengelola layanan alat tangkap email Mailpit.
• web: Mengelola layanan Web (misal: web server aktif atau antarmuka web terkait ServBay, sesuai kebutuhan penggunaan).
• ollama: Mengelola layanan model bahasa besar lokal Ollama.

Catatan bahwa servbayctl kini dapat langsung mengelola beberapa layanan inti latar belakang, termasuk Nginx dan Apache. Meski ServBay mendukung instalasi banyak paket perangkat lunak lain (misalnya Java, Python, Go, .NET, Ruby, Rust, dll), software tersebut biasanya tidak berjalan sebagai layanan latar belakang yang dikontrol langsung oleh servbayctl. Melainkan, aplikasi-aplikasi itu diakses atau digunakan secara langsung dari terminal atau melalui cara manajemen masing-masing. Fokus utama servbayctl adalah untuk layanan utama yang berjalan sebagai proses daemon inti sebagaimana pada daftar di atas.

Contoh Kasus Penggunaan

Berikut adalah contoh skenario penggunaan servbayctl yang umum:

1. Menukar Versi PHP dengan Cepat untuk Pengujian:

   servbayctl stop php -all
   servbayctl start php 8.2

2. Me-restart Layanan Database Setelah Perubahan Konfigurasi:

   # Misal kamu mengubah my.cnf atau my.ini
   servbayctl restart mysql

3. Memastikan Semua Layanan Sudah Dimatikan, Misal Sebelum Shutdown atau Update ServBay:

   servbayctl stop-all

4. Mengecek Apakah Web Server Berjalan:

   servbayctl status caddy

5. Otomatisasi Memulai Lingkungan Pengembangan melalui Skrip:

   #!/bin/bash
   
   echo "Menghentikan semua layanan ServBay..."
   servbayctl stop-all
   
   echo "Memulai layanan yang dibutuhkan..."
   servbayctl start php 8.1
   servbayctl start mysql
   servbayctl start caddy
   servbayctl start redis
   
   echo "Seluruh layanan ServBay telah berjalan."

Hal-Hal Penting dan Praktik Terbaik

• Tambahkan ke PATH: Sangat disarankan menambahkan direktori tempat servbayctl berada ke PATH sistem agar lebih hemat waktu dalam pengetikan perintah.
• Gunakan kill dengan Bijak: Perintah kill memaksa mematikan proses, yang bisa menyebabkan kehilangan data atau status layanan tidak stabil. Jika memungkinkan, lebih baik gunakan stop atau restart.
• stop-all adalah Aksi Global: Perintah stop-all akan mematikan seluruh layanan latar belakang yang dikelola ServBay. Pastikan kamu memang ingin melakukan ini.
• Parameter Versi: Jika memakai parameter version, pastikan versi tersebut sudah terinstal dan didukung oleh ServBay. Kamu bisa memeriksanya melalui GUI ServBay.
• Penanganan Error: Jika perintah servbayctl gagal, biasanya akan muncul pesan kesalahan di terminal. Gunakan pesan error ini untuk troubleshooting, atau periksa file log terkait di folder logs dalam direktori instalasi ServBay untuk informasi lebih detail.
• Kombinasi GUI & CLI: servbayctl adalah alat pelengkap GUI. Untuk perubahan konfigurasi yang kompleks atau melihat gambaran umum, GUI seringkali tetap lebih nyaman.

Pertanyaan yang Sering Diajukan (FAQ)

T: Ketika saya menjalankan perintah servbayctl muncul pesan command not found, harus bagaimana?

J: Biasanya ini karena direktori /Applications/ServBay/script belum ditambahkan ke PATH lingkungan sistem. Ikuti petunjuk pada bagian “Persyaratan Awal” dokumen ini untuk menambahkannya ke PATH.

T: Saya berhasil menjalankan servbayctl start <service>, tetapi layanan tidak berjalan. Bagaimana cara mengecek masalahnya?

J:

1. Jalankan servbayctl status <service> untuk memeriksa status layanan.
2. Periksa folder logs di direktori instalasi ServBay dan cari file log error untuk layanan tersebut, biasanya akan ditemukan penyebab gagalnya menjalankan layanan.
3. Coba jalankan layanan yang sama via GUI ServBay, kadang-kadang notifikasi error di GUI lebih informatif.
4. Pastikan file konfigurasi layanan tidak bermasalah.

T: Apakah parameter -all berlaku untuk semua layanan?

J: Parameter -all terutama berlaku untuk layanan yang mendukung instalasi beberapa versi sekaligus, seperti PHP. Untuk sebagian besar database (MySQL, PostgreSQL, dll) serta web server (Caddy), biasanya hanya ada satu instansi aktif. Penggunaan -all di sini umumnya sama saja dengan hanya menyebut nama layanan, tetapi untuk kejelasan, gunakan nama layanannya langsung. Untuk layanan seperti Redis atau Memcached yang mungkin berjalan multi-instan melalui port berbeda, -all akan mengontrol semua instance (perilaku detail tergantung pada implementasi ServBay).

Kesimpulan

servbayctl adalah antarmuka baris perintah yang kuat dari ServBay bagi para pengembang, memberikan fleksibilitas dan efisiensi dalam mengelola layanan lingkungan pengembangan lokal. Dengan menguasai berbagai perintah seperti start, stop, reload, restart, kill, status, stop-all beserta parameter seperti version dan -all, kamu dapat dengan mudah mengelola layanan utama seperti PHP, MySQL, MariaDB, PostgreSQL, MongoDB, Redis, Memcached, Caddy, dan banyak lagi langsung dari terminal. Hal ini memudahkan otomatisasi workflow dan mengoptimalkan pengalaman pengembanganmu.