CLI adalah surface terminal utama RelGeo.
Gunakan surface ini saat Anda ingin bekerja dari shell tanpa membuka UI browser.
Kapan CLI Cocok
CLI paling cocok untuk:
- memvalidasi dokumen RelGeo
- mengompilasi source menjadi JSON, SVG, atau graph
- memasukkan RelGeo ke workflow shell
- menjalankan pemeriksaan ringan di CI
Jika yang Anda butuhkan adalah authoring interaktif, gunakan Playground.
Bentuk Surface Saat Ini
Pada snapshot repo aktif saat ini:
- package surface-nya berada di repository
relgeo/cli - CLI mengikuti kontrak bahasa aktif v0.5
- jalur konsumsi paling sehat saat ini masih melalui monorepo ini
Kemampuan Dasar
Secara praktis, CLI saat ini sudah mencakup:
infountuk membaca struktur dokumencompileuntuk menghasilkan outputcheckatauvalidateuntuk validasi tanpa output final- parameter override
- pemilihan profil
- sheet target untuk ekspor SVG
Contoh Alur
pnpm relgeo info path/to/design.yaml
pnpm relgeo compile path/to/design.yaml
pnpm relgeo compile path/to/design.yaml -f svg -o output.svg
pnpm relgeo check path/to/design.yaml
Boundary Penting
CLI bukan editor interaktif.
CLI juga bukan pengganti @relgeo/core bila Anda ingin integrasi runtime langsung ke kode.
Gunakan CLI bila kebutuhan Anda adalah:
- automation
- terminal workflow
- compile atau validate tanpa UI
Status Dokumentasi
Halaman ini adalah entry surface milik website.
Rumah dokumentasi yang lebih dekat ke package sekarang mulai hidup di docs/README.md milik repository CLI.
Lanjut Membaca
- baca Playground bila Anda ingin authoring interaktif
- baca Surface Markdown bila Anda ingin embedding di markdown
- buka Spesifikasi Bahasa saat membutuhkan kontrak bahasa aktif