Home

DocxTerminal Wiki

Selamat datang di dokumentasi DocxTerminal, alat manajemen cheat sheet Markdown berbasis terminal yang ringan dan efisien.

Beranda (Home)

DocxTerminal adalah aplikasi CLI/TUI untuk mengelola catatan teknis atau cheat sheet dalam format Markdown. Aplikasi ini menggunakan sistem penyimpanan berbasis file (file-based) sehingga data Anda tetap portabel dan mudah diakses.

• Perintah Utama: dt
• Penyimpanan: ~/.docxterminal/ (Linux/macOS) atau %USERPROFILE%\.docxterminal\ (Windows)
• Kebutuhan: Go 1.24+

Instalasi (Installation)

Prasyarat

Pastikan Anda telah menginstal Go versi 1.24 atau lebih baru.

Langkah-langkah

1. Kloning repositori:

   git clone https://github.com/satriazoid/DocxTerminal.git
   cd DocxTerminal

2. Jalankan skrip instalasi sesuai sistem operasi:
   • Linux / macOS: bash install.sh
   • Windows (Git Bash): bash install.sh
   • Windows (CMD): install.bat
   • Windows (PowerShell): powershell -ExecutionPolicy Bypass -File install.ps1

Penggunaan (Usage)

Antarmuka TUI (Text User Interface)

Jalankan perintah dt untuk membuka menu interaktif.

Tombol	Fungsi
j / k atau ↓ / ↑	Navigasi pilihan
Enter	Pilih dokumen
e	Edit dokumen (saat mode baca)
y / n	Konfirmasi penghapusan
q / Esc	Kembali atau keluar

Menu TUI:

• List: Melihat daftar dokumen. Tekan Enter untuk membaca (menggunakan Glamour), e untuk mengedit.
• Add: Membuat dokumen baru dengan nama kustom.
• Edit: Memilih dokumen yang ada untuk diedit.
• Delete: Menghapus dokumen dengan konfirmasi keamanan.
• Quit: Menutup aplikasi.

Baris Perintah (CLI)

Anda juga dapat mengelola dokumen langsung melalui terminal:

dt list              # Menampilkan daftar semua dokumen
dt show <nama>       # Mencetak konten markdown ke layar
dt add <nama>        # Membuat dokumen baru dan membuka editor
dt edit <nama>       # Membuka dokumen yang sudah ada di editor
dt delete <nama>     # Menghapus dokumen
dt help              # Menampilkan bantuan perintah

Alias yang didukung: ls, cat, rm.

Penyimpanan & Editor (Storage & Configuration)

Lokasi File

Semua dokumen disimpan sebagai file .md individu di direktori tersembunyi:

• Unix-like: ~/.docxterminal/
• Windows: %USERPROFILE%\.docxterminal\

Editor Teks

DocxTerminal akan mendeteksi editor teks secara otomatis dengan urutan prioritas:

1. Variabel lingkungan $EDITOR
2. Variabel lingkungan $VISUAL
3. vim
4. nano
5. notepad (khusus Windows)

Validasi Nama Dokumen

Nama dokumen hanya boleh mengandung huruf, angka, titik (.), garis bawah (_), dan tanda hubung (-). Sistem menolak path traversal demi keamanan.

Dokumen Awal (Seed Data)

Saat pertama kali dijalankan, DocxTerminal akan membuatkan beberapa cheat sheet dasar untuk membantu Anda memulai:

• git.md
• npm.md
• pnpm.md
• yarn.md