Ana içeriğe geç

CLI

new Cli

new Cli(opts: {...})
SeçenektürAçıklama
binaryLabelstringYardım mesajında gösterilen araç adı
binaryNamestringKullanım satırında gösterilen ikili ad
binaryVersionstring--version parametresinde gösterilen araç sürümü
enableCapturebooleanAyarlandığında, stdout/stderr'yi komut akışlarına yönlendirir
enableColorsbooleanHata mesajları için otomatik renk algılamasını göz ardı eder

Cli#process

cli.process(input: string[])

Verilen argümanları kısmen doldurulmuş bir komut örneğine dönüştürür.

tehlike

execute metodunu çağırmayın, çünkü bazı alanların komut gerçekten çalıştırılmadan önce ayarlanması gerekir.

Bunun yerine, gerçekten çalıştırmak istiyorsanız, bunu Cli#run metoduna iletin.


Cli#run

cli.run(input: Command, context: Context)
cli.run(input: string[], context: Context)

Verilen argümanı hemen çalıştırılacak ve döndürülecek bir komuta dönüştürür.

ipucu

Çalıştırma sırasında bir hata olursa, Cli#run bunu yakalayacak ve çıkış kodunu 1 olarak döndürecektir.


Cli#runExit

cli.runExit(input: string[], context?: Context)

Cli#run metoduyla aynı şeydir, ancak komutun sonucunu yakalar ve process.exitCode değerini uygun şekilde ayarlar.

not

process.exit doğrudan çağrılmayacağından, olay döngüsü boş değilse süreç hayatta kalabilir.