CLI Referansı

Consul Guardian tek bir binary olarak tüm işlevleri sunar. Her komut consul-guardian <komut> şeklinde çalıştırılır.

Global Flag'ler

Bu flag'ler tüm komutlarda geçerlidir:

Flag	Kısaltma	Varsayılan	Açıklama
--config	-c	consul-guardian.yaml	Yapılandırma dosyası yolu
--consul-addr		http://127.0.0.1:8500	Consul sunucu adresi
--consul-token			Consul ACL token
--log-level		info	Log seviyesi: debug, info, warn, error
--log-format		text	Log formatı: json, text

Ortam Değişkenleri

Tüm flag'ler ortam değişkeni ile de ayarlanabilir. CONSUL_GUARDIAN_ öneki kullanılır:

export CONSUL_GUARDIAN_CONSUL_ADDRESS=http://consul:8500
export CONSUL_GUARDIAN_CONSUL_TOKEN=my-token
export CONSUL_GUARDIAN_LOG_LEVEL=debug

Ayrıca Consul'un kendi ortam değişkenleri de desteklenir:

export CONSUL_HTTP_ADDR=http://consul:8500
export CONSUL_HTTP_TOKEN=my-token

---

watch

Consul KV değişikliklerini gerçek zamanlı izler ve Git'e commit eder.

consul-guardian watch [flags]

Flag'ler

Flag	Varsayılan	Açıklama
--prefix	""	İzlenecek KV prefix'leri (virgüllü)
--exclude-prefix	""	Hariç tutulacak prefix'ler
--git-repo	./consul-backup	Git repo dizini
--poll-interval	5m	Blocking query bekleme süresi

Örnekler

# Temel kullanım
consul-guardian watch --prefix "config/"

# Birden fazla prefix
consul-guardian watch --prefix "config/,env/,feature-flags/"

# Prefix hariç tutma
consul-guardian watch \
  --prefix "config/" \
  --exclude-prefix "config/ephemeral/"

# Özel Consul adresi ve token
consul-guardian watch \
  --consul-addr http://consul.internal:8500 \
  --consul-token "$CONSUL_TOKEN" \
  --prefix "config/"

---

dashboard

Watch + Web UI'ı tek bir process'te çalıştırır.

consul-guardian dashboard [flags]

Flag'ler

watch komutundaki tüm flag'lere ek olarak:

Flag	Varsayılan	Açıklama
--listen	:9090	HTTP sunucu adresi
--static-dir	./frontend/dist	Frontend build dizini

Örnekler

# Dashboard başlat
consul-guardian dashboard \
  --consul-addr http://localhost:8500 \
  --prefix "config/,env/" \
  --git-repo ./consul-backup \
  --listen :9090

# Farklı port
consul-guardian dashboard --listen :3000

---

drift

Git ile Consul arasındaki konfigürasyon sapmalarını (drift) tespit eder.

consul-guardian drift [flags]

Flag'ler

Flag	Varsayılan	Açıklama
--prefix	""	Kontrol edilecek prefix
--source	git	Kaynak: git
--format	text	Çıktı formatı: text, json
--exit-code	false	Drift varsa çıkış kodu 1 döndür
--alert	""	Uyarı kanalı: slack, webhook

Örnekler

# Temel drift kontrolü
consul-guardian drift --prefix "config/"

# CI/CD için (drift varsa pipeline başarısız olur)
consul-guardian drift --prefix "config/production/" --exit-code

# JSON çıktısı
consul-guardian drift --format json

# Slack uyarısı ile
consul-guardian drift --prefix "config/" --alert slack

---

restore

Git geçmişinden Consul KV değerlerini geri yükler.

consul-guardian restore [flags]

Flag'ler

Flag	Varsayılan	Açıklama
--prefix	""	Geri yüklenecek prefix
--from	git	Kaynak: git
--revision	HEAD	Git revizyonu (commit hash veya referans)
--dry-run	false	Sadece önizleme, değişiklik yapma

Örnekler

# Dry-run ile önizleme (her zaman önce bunu yap!)
consul-guardian restore \
  --prefix "config/production/" \
  --from git \
  --revision HEAD~3 \
  --dry-run

# Gerçek restore
consul-guardian restore \
  --prefix "config/production/" \
  --from git \
  --revision HEAD~3

# Belirli commit'e geri dön
consul-guardian restore \
  --prefix "config/production/database" \
  --from git \
  --revision abc1234

# Tek key geri yükle
consul-guardian restore \
  --prefix "config/production/redis" \
  --from git \
  --revision HEAD~1

---

snapshot

Consul cluster snapshot işlemleri.

snapshot save

consul-guardian snapshot save [flags]

Flag	Varsayılan	Açıklama
--storage	local	Depolama: local, s3, gcs
--path	./snapshots	Yerel depolama dizini
--bucket	""	S3/GCS bucket adı
--prefix	""	Depolamadaki prefix
--region	""	AWS region

Örnekler

# Yerel dosya sistemine
consul-guardian snapshot save --storage local --path /backups/

# S3'e
consul-guardian snapshot save \
  --storage s3 \
  --bucket consul-backups \
  --prefix dc1/ \
  --region eu-west-1

---

version

Versiyon bilgisini yazdırır.

consul-guardian version

Çıktı:

consul-guardian v0.1.0 (abc1234) built 2026-04-04T10:00:00Z

---

Hızlı Referans Tablosu

Komut	Ne Yapar	Örnek
watch	KV değişikliklerini izle, Git'e commit et	consul-guardian watch --prefix "config/"
dashboard	Watch + Web UI başlat	consul-guardian dashboard --listen :9090
drift	Git vs Consul farkını bul	consul-guardian drift --exit-code
restore	Git'ten geri yükle	consul-guardian restore --dry-run
snapshot save	Cluster snapshot al	consul-guardian snapshot save --storage s3
version	Versiyon göster	consul-guardian version