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.
| Fiil | Komut | İşlevi |
|---|---|---|
| Başlat | collie start | Gerekirse derleyin, sunun, URL'yi yazdırın |
| Durdur | collie stop | Köprüyü duraklatın; hiçbir şeyi kaldırmaz |
| Yeniden başlat | collie restart | Durdurun, ardından başlatın |
| Durum | collie status | Collie çalışıyor başlığı + URL'ler |
| URL | collie url | tailnet URL'sini yazdırın |
| QR | collie qr | Taranabilir bir kod olarak aynı URL |
| Sürüm | collie version | Çalışan sürüm (0.x.y+sha) |
| Beceri | collie skill | Terminalinizde çalışan bir yapay zeka kodlama aracısı için Collie hakkındaki aracı özeti (ayrıca collie --skill) |
| Belgeler | collie docs · collie docs <name> · collie docs --all | Doğrudan ikili dosyanın kendisinden yazdırılan bu sayfalar |
| Güncelle | collie update | Ana 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 Al | collie 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ır | collie uninstall | Hizmeti kaldırın; .env ve kurulumu saklayın |
| Eşle | collie pair | 10 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 |
| Cihazlar | collie devices list · collie devices revoke <label> | Eşlenen cihazları listeleyin / iptal edin |
| Bağla | collie link · collie unlink | collie ögesini PATH'inize ekleyin (aşağıda) |
| Günlükler | collie logs | journal / günlük dosyasını canlı takip edin |
| Ses | collie stt setup · stt test · stt status · stt off | sesli girdi yapılandırın / denetleyin / devre dışı bırakın |
| Push anahtarları | collie push-keys | VAPID anahtar çiftini .env dosyanıza oluşturun |
| Push testi | collie 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 downBir ç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 |
|---|---|---|
start | collie start | Gerekirse derleyin, servisi başlatın, tailscale serve, URL'yi ve başlığı yazdırın |
stop | collie stop | Köprüyü duraklatın; hiçbir şeyi kaldırmaz |
restart | collie restart | stop + start |
status | collie status | Collie çalışıyor başlığı — hazırlık durumu ✓/⚠, sürüm, URL'ler |
url | collie url | tailnet URL'sini yazdırın |
version | collie version | Çalışan sürümü yazdırın (0.x.y+sha) |
update | collie update | Çalışma kopyasını ilerletin (pull veya fetch + re-detach) + yeniden derleyin + yeniden başlatın |
uninstall | collie uninstall | Servisi kaldırın (.env ve çalışma kopyasını korur) |
push-keys | collie push-keys | Servisin okuduğu .env içine bir VAPID anahtar çifti yazın |
push-test | collie push-test | Abone 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 yoksabin/colliederler 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