18/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 ajanı için Collie hakkındaki ajana yönelik özet bilgi (ayrıca collie --skill). collie skill install, uninstall, sync, status ve print, ajanlarınızın talimat dosyalarındaki walky talky yeteneğini yönetir; collie update, her güncellemeden sonra sync çalıştırır (Yeteneği yükleyin) |
| 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 · collie pair --expires <duration> | 10 dakika geçerli olan 8 karakterlik bir kod ve bir QR kodu yazdırın; kod doldurulmuş olarak Ayarlar → Sistem → Eşlenen cihazlar bölümünü açmak için QR kodunu tarayın ya da eşlendi almak için kodu el ile girin. --expires olmadan belirtecin süresi asla dolmaz ve komut bunu belirtir; bununla birlikte (12h, 30d, 2w) komut, kod talep edildikten sonra belirtecin çalışmayı durduracağı tarihi yazdırır. Bir betik, kodu örneğin script gibi kendine ait bir etiketle talep eder ve bir kez eşler (Bir cihaza son kullanma süresi verme) |
| Cihazlar | collie devices list · collie devices revoke <label> · collie devices set-expiry <label> <duration> · collie devices clear-expiry <label> | Eşlenen cihazları listeleyin / iptal edin veya birinin süresinin ne zaman süresi dolar değiştirin. list her cihazın geçerlilik süresini no expiry, expires <date> veya EXPIRED <date> olarak gösterir. set-expiry şu andan itibaren yeni bir kullanım ömrü başlatır; clear-expiry cihazı kaldırır. Bir etiket tam olarak eşleşir veya yalnızca tek bir cihaz uyuyorsa büyük/küçük harf duyarsız eşleşir |
| Bağla | collie link · collie unlink | collie ögesini PATH'inize ekleyin (aşağıda) |
| Günlükler | collie logs | Hizmet günlüğünü izleyin (tail) |
| Yapılandırma | collie config show · collie config check · collie config init | Her ayarı kaynağıyla birlikte yazdırın, dosyayı doğrulayın veya açıklamalı bir config.toml yazın (yapılandırma dosyası) |
| Dayanıklı aracılar | collie durable attach <name> --socket <path> · collie durable attach <name> --url <url> --token-env <VAR> · collie durable detach <name> · collie durable list | sources.json konumuna kalıcı bir ajan ekleyin, ajanı kaldırın veya çalışan köprünün verdiği durumla her kalıcı ajanı listeleyin. attach ve detach bir sonraki yeniden başlatmada ya da --restart ile hemen uygulanır. Bayraklar, çıktı ve çıkış kodları: Dayanıklı aracılar |
| Telsiz | collie walky who · collie walky send <address> <text> · collie walky reply <id> <text> · collie walky inbox · collie walky status <id> | Bir uçbirimden veya bir aracıdan diğerine bir aracı oturumuna mesaj gönderin (Telsiz) |
| 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 doctor hangi durumu okuduğunu belirtir. İlk satırı örneği (default veya COLLIE_INSTANCE içindeki adı) ve okuduğu durum dizinini belirtir. Bir makinede iki şerit çalıştırıyorsanız, geri kalanına güvenmeden önce bu satırı kontrol edin; çünkü yanlış COLLIE_INSTANCE değerine sahip bir kabuk yanlış şeridi okur. --json, collie girdisinde instance ve stateDir ile aynı iki değeri verir.
collie doctor aracı programlarınızı listeler. Collie'nin giriş profiline sahip olduğu her program bir harness-<name> satırı alır: Collie'nin oturum açma kabuğunuzun PATH üzerinde çalıştıracağı dosya, yazdırdığı sürüm ve profilin bu sürüm hakkındaki kararı. Doğrulanmış aralığın üzerindeki bir sürüm yalnızca bir nottur, çünkü bir turdaki gönderimlere yine de güvenilir. Satır, dosya çözümlendiğinde ancak sürümü okunamadığında uyarır; örneğin PATH üzerinde ilk sırada yer alan ve $HOME gerektiren bir sarmalayıcı veya bozuk bir kurulum: sürüm okunana kadar Collie bu programa yapılan her göndermeyi geçici olarak ele alır. Yüklü olmayan bir program not installed gösterir. --json içinde her satır ayrıca harness, binary, version ve profileStatus taşır.
Satır, PATH üzerindeki kopyayı adlandırır, çünkü collie doctor bakacak bir bölmeye sahip değildir. Herdr üzerindeki bir gönderme, kendi bölmesinde çalışan programa sorar; bu nedenle tam yolu ile başlatılan veya bir projede yüklü olan başka bir kopyayı çalıştıran bir bölme, makbuzlarında o kopyanın sürümünü gösterir.
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şturulmuş Yalnızca Herdr tarafından yönetilen bir kurulum için geçerlidir. Herdr, Collie tarafından desteklenen beş çoğullayıcıdan biridir. Bu eylemler doğrudan bağdaştırıcıyla eşleşir: her eylem fiili yukarıdaki tabloda belgelenen aynı collie ikili dosyasına iletir. scripts/install.sh üzerinden oluşturulan ikili yüklemelerde eklenti eylemleri mevcut değildir ve geçerli 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, stt ve config komutlarının karşılık gelen bir eklenti eylemi yoktur; çünkü bir terminal, konumsal bağımsız değişkenler veya her ikisini birden gerektirirler. 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