İçeriğe atla
ColliePWA

05/Documentation

Komutlar

Her collie eylemi, collie dizinini PATH değişkeninize ekleme ve Herdr tarafından yönetilen bir kurulumda bu eylemleri yansıtan Herdr işlemleri

Her fiil collie <verb> biçimini kullanır. Bu, doğrudan ikili dosyada (cli/) uygulanan ve tüm kurulumlarda geçerli olan kurallı sözdizimidir. collie dizinini PATH değişkeninize eklemeden önce (aşağıda), depo kökünden bin/collie <verb> çalıştırın. Herdr tarafından yönetilen bir kurulumda bu fiiller, aynı davranışla Herdr eylemleri (aşağıda) olarak kaydedilir.

Ana makinede birden fazla örnek çalışıyorsa her fiilin başına COLLIE_INSTANCE=<name> ekleyin. Bkz. Tek bir konakta birden fazla Collie örneği.

FiilKomutİşlevi
Başlatcollie startGerekirse derleyin, sunun, URL'yi yazdırın
Durdurcollie stopKöprüyü duraklatın; hiçbir şeyi kaldırmaz
Yeniden başlatcollie restartDurdurun, ardından başlatın
Durumcollie statusCollie çalışıyor başlığı + URL'ler
URLcollie urltailnet URL'sini yazdırın
QRcollie qrTaranabilir bir kod olarak aynı URL
Sürümcollie versionÇalışan sürüm (0.x.y+sha)
Becericollie skillTerminalinizde çalışan bir yapay zeka kodlama aracısı için Collie hakkındaki aracı özeti (ayrıca collie --skill)
Belgelercollie docs · collie docs <name> · collie docs --allDoğrudan ikili dosyanın kendisinden yazdırılan bu sayfalar
Güncellecollie updateAna sürümünüzün en yeni sürümünü hazırlayın, ona geçin, yeniden başlatın ve doğrulayın (--check ön kontrolleri yapar, --status bildirir, --major birini geçer)
Geri Alcollie update --rollbackÖnceki sürümü geri yükleyin (hazırlanmış sürümü bulunmayan, Herdr tarafından yönetilen bir kopyada geçerli değildir)
Kaldırcollie uninstallHizmeti kaldırın; .env ve kurulumu saklayın
Eşlecollie pair10 dakika geçerli olan 8 karakterlik bir kod ve bir QR kod yazdırın; kod doldurulmuş şekilde Ayarlar → Eşlenen cihazlar bölümünü açmak için QR kodu tarayın veya eşlendi için kodu manuel olarak girin
Cihazlarcollie devices list · collie devices revoke <label>Eşlenen cihazları listeleyin / iptal edin
Bağlacollie link · collie unlinkcollie ögesini PATH'inize ekleyin (aşağıda)
Günlüklercollie logsjournal / günlük dosyasını canlı takip edin
Sescollie stt setup · stt test · stt status · stt offsesli girdi yapılandırın / denetleyin / devre dışı bırakın
Push anahtarlarıcollie push-keysVAPID anahtar çiftini .env dosyanıza oluşturun
Push testicollie push-testÇalıştığını doğrulamak için bir bildirim gönderin

CLI ayrıca daha seyrek gerçekleştirilen görevler için build, serve, unserve, doctor ve crew … komutlarını da içerir.

Hem start hem de status, Collie çalışıyor başlığını çıktılar: bir durum işareti ve sürüm, ardından bir service, bir local ve bir tailnet satırı. İlk çalıştırma, başarısız bir durum denetiminde ne yazdırıldığı dahil olmak üzere başlığı tam olarak gösterir. Bildirilen sürüm, sunulan paket damgasından okunur ve etkin derlemeyi yansıtır.

Ink veya düz metin. stdout bir TTY olduğunda start, status, doctor, crew add ve crew status komutları etkileşimli bir terminal arayüzü sunar. --plain parametresini geçirmek veya çıktıyı bir boruya, dosyaya, systemd günlüğüne ya da CI çalıştırıcısına yönlendirmek ham satır çıktısına geri döner.

collie dizinini PATH ortam değişkeninize ekleyin

~/.local/bin/collie ögesini yayınlamak için collie link komutunu çalıştırın:

bin/collie link          # ~/.local/bin/collie → <checkout>/bin/collie
collie status            # from anywhere
bin/collie unlink        # take the name back down

Bir çalışma kopyasının ikili dosyasına sembolik bağ oluşturur; böylece gelecekteki collie build güncellemeleri ek bir adıma gerek kalmadan hemen geçerli olur (ADR 0021). Komut, diğer Collie çalışma kopyalarından kalan mevcut bağlantıların yerine geçer ve hangisinin üzerine yazdığını bildirir. Bu yoldaki Collie dışı dosyaların üzerine yazmayı reddeder. unlink, sembolik bağı yalnızca sizin geçerli çalışma kopyasını hedefliyorsa kaldırır.

~/.local/bin dizini PATH içinde yoksa link sizi uyarır ve çıkar. Kabuk profilinizi asla düzenlemez. path-link satırını denetlemek ve yalın collie komutunun hangi çalışma kopyasına çözümlendiğini görmek için collie doctor komutunu çalıştırın.

Herdr eylemleri

herdr plugin install AltanS/collie veya herdr plugin link ile oluşturulan Yalnızca Herdr tarafından yönetilen bir kurulum için geçerlidir. Herdr, Collie tarafından desteklenen üç çoğullayıcıdan biridir. Bu eylemler doğrudan bağdaştırıcıya eşlenir: her eylem, fiili yukarıdaki tabloda belgelenen aynı collie ikili dosyasına iletir. scripts/install.sh aracılığıyla oluşturulan ikili kurulumlarda eklenti eylemleri bulunmaz ve tek sözdizimi collie <verb> olur.

Collie bu eylemleri herdr-plugin.toml içine kaydeder. Bunları herdr plugin action invoke <id> --plugin herdr.collie ile çağırın veya herdr plugin action list --plugin herdr.collie ile görüntüleyin:

<id>Eşdeğer fiilİşlevi
startcollie startGerekirse derleyin, servisi başlatın, tailscale serve, URL'yi ve başlığı yazdırın
stopcollie stopKöprüyü duraklatın; hiçbir şeyi kaldırmaz
restartcollie restartstop + start
statuscollie statusCollie çalışıyor başlığı — hazırlık durumu ✓/⚠, sürüm, URL'ler
urlcollie urltailnet URL'sini yazdırın
versioncollie versionÇalışan sürümü yazdırın (0.x.y+sha)
updatecollie updateÇalışma kopyasını ilerletin (pull veya fetch + re-detach) + yeniden derleyin + yeniden başlatın
uninstallcollie uninstallServisi kaldırın (.env ve çalışma kopyasını korur)
push-keyscollie push-keysServisin okuduğu .env içine bir VAPID anahtar çifti yazın
push-testcollie push-testAbone olan her cihaza bir bildirim gönderin

qr, pair, devices, link, logs ve stt, bir terminal, konumsal bağımsız değişkenler veya her ikisini birden gerektirdiğinden karşılık gelen bir eklenti eylemine sahip değildir. Bunları collie <verb> olarak çalıştırın.

Herdr eylemleri, terminal başlığı yerine Herdr'ın JSON zarfını döndürür. Eylemin yakalanan stdout çıktısını herdr plugin log list --plugin herdr.collie ile görüntüleyin veya çıktıyı doğrudan satır içinde yazdırmak için collie <verb> komutunu çalıştırın. herdr plugin list --json çıktısı, etkin sürümü değil, plugin link sırasında önbelleğe alınan sürümü yansıtır. Bağlantılı klonlar için update, önbelleği düzeltmek amacıyla otomatik olarak yeniden bağlar. Bunu herdr plugin link "$(pwd)" ile zorlayabilirsiniz. Herdr ≥0.8.0, bildirimi her çağrıda diskten yeniden okur.

Not. scripts/collie-ctl.sh <verb> desteklenmeye devam eder. Bir önyükleme dolgusu (bootstrap shim) olarak çalışır: Bun'ı bulur, depoda yoksa bin/collie derler ve argv değerini iletir. Yeni bağlanmış bir klon, ilk ikili dosyasını derlemek için bu yolu kullanır. Herdr eylemleri bu betiğe işaret etmeyi sürdürür; çünkü Herdr <0.8.0, yükleme sırasında önbelleğe alınan eylem tanımlarını dondurur (ADR 0006). Her eylem fiili, cli/ içindeki derlenmiş ikili dosya içinde bir kez uygulanır.

Bu sayfayı GitHub üzerinde düzenleyin