CLI
armin CLI seçenekleri ve komutları.
armin CLI herhangi bir argüman olmadan çalıştırıldığında varsayılan olarak TUI’yi başlatır.
arminAncak bu sayfada belgelendiği gibi komutları da kabul eder. Bu, armin ile programlı olarak etkileşim kurmanıza olanak tanır.
armin run "Explain how closures work in JavaScript"tui
armin terminal kullanıcı arayüzünü başlatır.
armin [project]Bayraklar
| Bayrak | Kısa | Açıklama |
|---|---|---|
--continue | -c | Son oturuma devam et |
--session | -s | Devam edecek oturum kimliği |
--fork | Devam ederken oturumu fork’lar (--continue veya --session ile kullanın) | |
--prompt | Kullanılacak prompt | |
--model | -m | provider/model biçiminde kullanılacak model |
--agent | Kullanılacak agent | |
--port | Dinlenecek port | |
--hostname | Dinlenecek host adı |
Komutlar
armin CLI ayrıca aşağıdaki komutlara da sahiptir.
agent
armin için agent’ları yönetin.
armin agent [command]attach
serve veya web komutlarıyla başlatılan, halihazırda çalışan bir armin arka uç sunucusuna bir terminal ekleyin.
armin attach [url]Bu, TUI öğesinin uzak bir armin arka ucuyla kullanılmasına olanak tanır. Örneğin:
# Start the backend server for web/mobile accessarmin web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendarmin attach http://10.20.30.40:4096Bayraklar
| Bayrak | Kısa | Tanım |
|---|---|---|
--dir | TUI’yi başlatmak için çalışma dizini | |
--session | -s | Devam edecek oturum açma bilgileri |
create
Özel yapılandırmaya sahip yeni bir agent oluşturun.
armin agent createBu komut, özel sistem istemi ve araç yapılandırmasıyla yeni bir agent oluşturma konusunda size yol gösterecektir.
list
Mevcut tüm agent’ları listeleyin.
armin agent listauth
Sağlayıcılar için kimlik bilgilerini ve oturum açmayı yönetme komutu.
armin auth [command]login
armin, Models.dev adresindeki sağlayıcı listesi tarafından desteklenmektedir, dolayısıyla kullanmak istediğiniz herhangi bir sağlayıcı için API anahtarlarını ayarlamak üzere armin auth login kullanabilirsiniz. Bu ~/.local/share/armin/auth.json’de saklanıyor.
armin auth loginarmin başlatıldığında sağlayıcıları kimlik bilgileri dosyasından yükler. Ayrıca ortam değişkenlerindeki veya projenizdeki .env dosyasındaki anahtarları da kullanır.
list
Kimlik bilgileri dosyasında depolanan tüm kimliği doğrulanmış sağlayıcıları listeler.
armin auth listVeya kısa versiyonu.
armin auth lslogout
Bir sağlayıcıyı kimlik bilgileri dosyasından temizleyerek oturumunuzu kapatır.
armin auth logoutgithub
Depo otomasyonu için GitHub aracısını yönetin.
armin github [command]install
GitHub aracısını deponuza yükleyin.
armin github installBu komut gerekli GitHub Actions workflow’unu kurar ve yapılandırma adımlarında size rehberlik eder. Daha fazla bilgi.
run
GitHub aracısını çalıştırın. Bu genellikle GitHub Eylemlerinde kullanılır.
armin github runBayraklar
| Bayrak | Açıklama |
|---|---|
--event | Aracıyı çalıştırmak için GitHub sahte olayı |
--token | GitHub personal access token |
mcp
Model Bağlam Protokolü sunucularını yönetin.
armin mcp [command]add
Yapılandırmanıza bir MCP sunucusu ekleyin.
armin mcp addBu komut, yerel veya uzak bir MCP sunucusu ekleme konusunda size yol gösterecektir.
list
Yapılandırılmış tüm MCP sunucularını ve bağlantı durumlarını listeleyin.
armin mcp listVeya kısa versiyonunu kullanın.
armin mcp lsauth
OAuth’un etkin olduğu bir MCP sunucusuyla kimlik doğrulaması yapın.
armin mcp auth [name]Sunucu adı belirtmezseniz mevcut OAuth özellikli sunucular arasından seçim yapmanız istenir.
Ayrıca OAuth özellikli sunucuları ve bunların kimlik doğrulama durumlarını da listeleyebilirsiniz.
armin mcp auth listVeya kısa versiyonunu kullanın.
armin mcp auth lslogout
MCP sunucusu için OAuth kimlik bilgilerini kaldırın.
armin mcp logout [name]debug
MCP sunucusu için OAuth bağlantı sorunlarının hatalarını ayıklayın.
armin mcp debug <name>models
Yapılandırılmış sağlayıcıların tüm mevcut modellerini listeleyin.
armin models [provider]Bu komut, yapılandırdığınız sağlayıcılardaki modelleri provider/model formatında listeler.
Bu, config dosyanızda kullanmanız gereken tam model adını bulmak için kullanışlıdır.
Modelleri bu sağlayıcıya göre filtrelemek için isteğe bağlı olarak bir sağlayıcı kimliğini iletebilirsiniz.
armin models anthropicBayraklar
| Bayrak | Tanım |
|---|---|
--refresh | Modeller.dev’den model önbelleğini yenileyin |
--verbose | Daha ayrıntılı model çıktısı kullanın (maliyetler gibi meta veriler içerir) |
Önbelleğe alınan model listesini güncellemek için --refresh bayrağını kullanın. Bu, bir sağlayıcıya yeni modeller eklendiğinde ve bunları armin’da görmek istediğinizde kullanışlıdır.
armin models --refreshrun
Doğrudan bir istem ileterek armin’u etkileşimli olmayan modda çalıştırın.
armin run [message..]Bu, komut dosyası oluşturma, otomasyon veya TUI’un tamamını başlatmadan hızlı bir yanıt istediğinizde kullanışlıdır. Örneğin.
armin run Explain the use of context in GoAyrıca, her çalıştırmada MCP sunucusunun soğuk önyükleme sürelerini önlemek için çalışan bir armin serve örneğine de ekleyebilirsiniz:
# Start a headless server in one terminalarmin serve
# In another terminal, run commands that attach to itarmin run --attach http://localhost:4096 "Explain async/await in JavaScript"Bayraklar
| Bayrak | Kısa | Açıklama |
|---|---|---|
--command | Çalıştırılacak komut, args için mesajı kullanın | |
--continue | -c | Son oturuma devam et |
--session | -s | Devam edecek oturum kimliği |
--fork | Devam ederken oturumu fork’lar (--continue veya --session ile kullanın) | |
--share | Oturumu paylaşın | |
--model | -m | provider/model biçiminde kullanılacak model |
--agent | Kullanılacak temsilci | |
--file | -f | Mesaja eklenecek dosya(lar) |
--format | Biçim: varsayılan (biçimlendirilmiş) veya json (ham JSON olayları) | |
--title | Oturumun başlığı (değer sağlanmazsa kısaltılmış bilgi istemi kullanılır) | |
--attach | Çalışan bir armin sunucusuna ekleyin (ör. http://localhost:4096) | |
--port | Yerel sunucunun bağlantı noktası (varsayılan olarak rastgele bağlantı noktasıdır) |
serve
API erişimi için headless bir armin sunucusu başlatır. Tam HTTP arayüzü için server docs sayfasına bakın.
armin serveBu, TUI arayüzü olmadan armin işlevselliğine API erişimi sağlayan bir HTTP sunucusunu başlatır. HTTP temel kimlik doğrulamasını etkinleştirmek için OPENCODE_SERVER_PASSWORD öğesini ayarlayın (kullanıcı adı varsayılan olarak armin şeklindedir).
Bayraklar
| Bayrak | Tanım |
|---|---|
--port | Dinlenecek bağlantı noktası |
--hostname | Dinlenecek ana bilgisayar adı |
--mdns | mDNS bulmayı etkinleştir |
--cors | CORS’a izin verecek ek tarayıcı kaynakları |
session
armin oturumlarını yönetin.
armin session [command]list
Tüm armin oturumlarını listeleyin.
armin session listBayraklar
| Bayrak | Kısa | Tanım |
|---|---|---|
--max-count | -n | En son N oturumla sınırla |
--format | Çıkış formatı: tablo veya json (tablo) |
stats
armin oturumlarınız için belirteç kullanımı ve maliyet istatistiklerini gösterin.
armin statsBayraklar
| Bayrak | Açıklama |
|---|---|
--days | Son N güne ait istatistikleri göster (tüm zamanlar) |
--tools | Gösterilecek araç sayısı (tümü) |
--models | Model kullanım dökümünü göster (varsayılan olarak gizlidir). En üstteki N’yi göstermek için bir sayı iletin |
--project | Projeye göre filtrele (tüm projeler, boş değer: mevcut proje) |
export
Oturum verilerini JSON olarak dışa aktarın.
armin export [sessionID]Bir oturum kimliği sağlamazsanız mevcut oturumlar arasından seçim yapmanız istenir.
import
Bir JSON dosyasından veya armin paylaşımından URL oturum verilerini içe aktarın.
armin import <file>Yerel bir dosyadan veya armin paylaşımından (URL) içe aktarabilirsiniz.
armin import session.jsonarmin import https://opncd.ai/s/abc123web
Web arayüzüyle başsız bir armin sunucusu başlatın.
armin webBu, bir HTTP sunucusunu başlatır ve bir web arayüzü aracılığıyla armin’a erişmek için bir web tarayıcısı açar. HTTP temel kimlik doğrulamasını etkinleştirmek için OPENCODE_SERVER_PASSWORD öğesini ayarlayın (kullanıcı adı varsayılan olarak armin şeklindedir).
Bayraklar
| Bayrak | Tanım |
|---|---|
--port | Dinlenecek bağlantı noktası |
--hostname | Dinlenecek ana bilgisayar adı |
--mdns | mDNS bulmayı etkinleştir |
--cors | CORS’a izin verecek ek tarayıcı kaynakları |
acp
Bir ACP (Ajan İstemci Protokolü) sunucusu başlatın.
armin acpBu komut, nd-JSON kullanarak stdin/stdout aracılığıyla iletişim kuran bir ACP sunucusunu başlatır.
Bayraklar
| Bayrak | Açıklama |
|---|---|
--cwd | Çalışma dizini |
--port | Dinlenecek port |
--hostname | Dinlenecek host adı |
uninstall
armin’u kaldırın ve ilgili tüm dosyaları kaldırın.
armin uninstallBayraklar
| Bayrak | Kısa | Tanım |
|---|---|---|
--keep-config | -c | Yapılandırma dosyalarını sakla |
--keep-data | -d | Oturum verilerini ve anlık görüntüleri saklayın |
--dry-run | Nelerin kaldırılmadan kaldırılacağı göster | |
--force | -f | Onay istemlerini atla |
upgrade
armin’u en son sürüme veya belirli bir sürüme günceller.
armin upgrade [target]En son sürüme yükseltmek için.
armin upgradeBelirli bir sürüme yükseltmek için:
armin upgrade v0.1.48Bayraklar
| Bayrak | Kısa | Açıklama |
|---|---|---|
--method | -m | Kullanılan kurulum yöntemi: curl, npm, pnpm, bun, brew |
Global bayraklar
armin CLI aşağıdaki global bayrakları destekler.
| Bayrak | Kısa | Tanım |
|---|---|---|
--help | -h | Yardımı görüntüle |
--version | -v | Sürüm numarasını yazdır |
--print-logs | Günlükleri stderr’e yazdır | |
--log-level | Günlük düzeyi (DEBUG, INFO, WARN, ERROR) |
Ortam değişkenleri
armin ortam değişkenleri kullanılarak yapılandırılabilir.
| Değişken | Tip | Açıklama |
|---|---|---|
OPENCODE_AUTO_SHARE | boolean | Oturumları otomatik olarak paylaş |
OPENCODE_GIT_BASH_PATH | string | Windows’ta yürütülebilir Git Bash’in Yolu |
OPENCODE_CONFIG | string | Yapılandırma dosyasının yolu |
OPENCODE_TUI_CONFIG | string | TUI yapılandırma dosyasının yolu |
OPENCODE_CONFIG_DIR | string | Yapılandırma dizinine giden yol |
OPENCODE_CONFIG_CONTENT | string | Satır içi JSON config içeriği |
OPENCODE_DISABLE_AUTOUPDATE | boolean | Otomatik güncelleme kontrollerini devre dışı bırak |
OPENCODE_DISABLE_PRUNE | boolean | Eski verilerin temizlenmesini devre dışı bırak |
OPENCODE_DISABLE_TERMINAL_TITLE | boolean | Otomatik terminal başlığı güncellemelerini devre dışı bırakın |
OPENCODE_PERMISSION | string | Satır içi JSON izin config’i |
OPENCODE_DISABLE_DEFAULT_PLUGINS | boolean | Varsayılan eklentileri devre dışı bırakın |
OPENCODE_DISABLE_LSP_DOWNLOAD | boolean | Otomatik LSP sunucu indirmelerini devre dışı bırakın |
OPENCODE_ENABLE_EXPERIMENTAL_MODELS | boolean | Deneysel modelleri etkinleştir |
OPENCODE_DISABLE_AUTOCOMPACT | boolean | Otomatik context sıkıştırmayı devre dışı bırak |
OPENCODE_DISABLE_CLAUDE_CODE | boolean | .claude’den okumayı devre dışı bırak (istem + beceriler) |
OPENCODE_DISABLE_CLAUDE_CODE_PROMPT | boolean | ~/.claude/CLAUDE.md dosyasını okumayı devre dışı bırak |
OPENCODE_DISABLE_CLAUDE_CODE_SKILLS | boolean | .claude/skills yüklemesini devre dışı bırak |
OPENCODE_DISABLE_MODELS_FETCH | boolean | Uzak kaynaklardan model getirmeyi devre dışı bırakın |
OPENCODE_FAKE_VCS | string | Test amaçlı sahte VCS sağlayıcısı |
OPENCODE_DISABLE_FILETIME_CHECK | boolean | Optimizasyon için dosya süresi kontrolünü devre dışı bırakın |
OPENCODE_CLIENT | string | Client kimliği (varsayılan: cli) |
OPENCODE_ENABLE_EXA | boolean | Exa web arama araçlarını etkinleştir |
OPENCODE_SERVER_PASSWORD | string | serve/web için temel kimlik doğrulamayı etkinleştirin |
OPENCODE_SERVER_USERNAME | string | Temel kimlik doğrulama kullanıcı adını geçersiz kıl (varsayılan armin) |
OPENCODE_MODELS_URL | string | Model yapılandırmasını almak için özel URL |
Deneysel
Bu ortam değişkenleri değişebilecek veya kaldırılabilecek deneysel özellikleri etkinleştirir.
| Değişken | Tip | Tanım |
|---|---|---|
OPENCODE_EXPERIMENTAL | boolean | Tüm deneysel özellikleri etkinleştir |
OPENCODE_EXPERIMENTAL_ICON_DISCOVERY | boolean | Simge bulmayı etkinleştir |
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | TUI’da seçim yapıldığında kopyalamayı devre dışı bırak |
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | number | MS cinsinden bash komutları için varsayılan zaman aşımı |
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX | number | LLM yanıtları için maksimum çıktı belirteçleri |
OPENCODE_EXPERIMENTAL_FILEWATCHER | boolean | Tüm dizin için dosya izleyiciyi etkinleştir |
OPENCODE_EXPERIMENTAL_OXFMT | boolean | Oxfmt biçimlendiriciyi etkinleştir |
OPENCODE_EXPERIMENTAL_LSP_TOOL | boolean | Deneysel LSP aracını etkinleştir |
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER | boolean | Dosya izleyiciyi devre dışı bırak |
OPENCODE_EXPERIMENTAL_EXA | boolean | Deneysel Exa özelliklerini etkinleştirin |
OPENCODE_EXPERIMENTAL_LSP_TY | boolean | python dosyaları için TY LSP’yi etkinleştir |
OPENCODE_EXPERIMENTAL_MARKDOWN | boolean | Deneysel işaretleme özelliklerini etkinleştir |
OPENCODE_EXPERIMENTAL_PLAN_MODE | boolean | Plan modunu etkinleştir |