Buat para software developer dan DevOps engineer di lingkungan Unix/Linux, pakai terminal itu udah kayak makanan sehari-hari. Entah itu buat deploy aplikasi, troubleshooting, atau jalanin tes, berbagai aktivitas lainnya. Nah, mendokumentasikan aktivitas-aktivitas tersebut bisa menjadi hal yang sangat berharga. Dokumentasi tersebut bisa sangat membantu saat nanti butuh debugging, share ilmu ke anggota tim yang lain hingga jadi evidence/bukti untuk comply dengan aturan kerja yang ada.
Tools screen recording yang ada saat ini kebanyakan kurang oke buat ngerekam interaksi di terminal secara efisien. Bayangin mesti bikin screen recording pake QuickTime, VLC, ScreenRec atau GNOME screen record. Atau OBS?
Output file videonya bakal gede-gede, nggak bisa dicari teksnya, dan sering butuh bandwidth gede buat di-share. Belum lagi kalau kita butuh proses perekaman ini terintegrasi dengan CI/CD pipeline.
Di sinilah asciinema mengambil peran.
Asciinema adalah sebuah tool open-source berbasis python yang mampu merekam sesi terminal kita jadi file berbasis teks yang ringan, bukan file video yang berat. Beda dengan software screen recording biasa, output Asciinema tuh efisien banget, jadi gampang diputar ulang, di-search dan di-share tanpa ribet dengan data file video yang besar.
Apa yang membedakan asciinema dengan screen recorder lainnya?
- Ukuran File Kecil: data recording asciinema disimpan dalam bentuk teks.
- Searchable: Karena datanya text file biasa, kita bisa nyari dan nyalin konten teks-nya langsung dari sesi yang direkam.
- Gampang Di-embed: Gampang banget nge-embed rekaman di dokumentasi, blog, dan tutorial. Kalian bisa lihat-lihat di link berikut ini untuk tutorial embed nya.
- Kolaboratif: bisa share sesi terminal interaktif, bukan cuma sekedar screenshot statis.
Seperti yang disinggung di atas, contoh penggunaan asciinema di antaranya adalah:
- Mendokumentasikan proses deployment, developer dapat membuatpanduan deployment yang bisa diulang dengan merekam tiap perintah yang dijalankan di terminal.
- Merekam sesi troubleshooting, daripada cuma kumpulan screenshot statis, engineer bisa merekam keseluruhan sesi debugging, jadi tim lebih gampang memahami cara debugging karena seakan sedang hands on secara langsung dan dapat lebih cepat menyelesaikan masalah yang dihadapi.
- Membuat tutorial interaktif, asciinema cocok banget untuk membuat tutorial yang menunjukkan workflow command-line tanpa perlu video berukuran besar.
Asciinema juga memiliki beberapa fitur keren yang sangat membantu. Diantaranya:
- Otomatisasi dengan API, kita bisa mengintegrasikan API Asciinema ke dalam pipeline CI/CD untuk merekam aktivitas terminal secara otomatis.
- Kustomisasi perekaman, asciinema mendukung playback rekaman dalam berbagai kecepatan, themes, juga pilihan font yang dapat dikonfigurasi. Hal ini membuat hasil rekaman kita akan lebih menarik secara visual.
Menarik kan?
Terlepas dari kemampuan dan fitur-fitur asciinema di atas, ada beberapa hal juga yang harus kita perhatikan dalam penggunaannya. Salah satunya terkait dengan keamanan (security), mengingat proses perekaman sesi terminalnya bisa diotomasi dan apalagi jika sampai rekamannya memang untuk dibagi (share) ke banyak pihak.
- Hindari menampilkan data-data sensitif. Jadi jangan sampai hasil rekamannya malah pamer data-data kredensial seperti API key, password, data PII dan sejenisnya. Jadi pastikan data-data tersebut tidak ditampilkan saat perekaman.
- Mengelola akses. Gunakan opsi private sharing untuk membatasi akses ke video/rekaman yang sensitif.
- Compliance, kepatuhan akan aturan perusahaan. Pastikan recording yang kita buat telah sesuai/comply dengan aturan keamanan perusahaan atau organisasi tempat kita bekerja.
Untuk lebih dalam lagi, teman-teman bisa membaca link di bawah ini.