vNext Workflow CLI

vNext Workflow CLI, geliştirme ortamında workflow component'lerini hızlıca deploy etmek, senkronize etmek ve CSX mapping'lerini yönetmek için kullanılan bir komut satırı aracıdır.

Package: @burgan-tech/vnext-workflow-cli Repo: github.com/burgan-tech/vnext-workflow-cli NPM: npmjs.com/package/@burgan-tech/vnext-workflow-cli

tip

vNext Forge Studio bu CLI'ı yerleşik olarak kullanır. Forge Studio üzerinden çalışıyorsanız ayrıca kurmanıza gerek yoktur.

Kurulum

# Global kurulum (önerilen)
npm install -g @burgan-tech/vnext-workflow-cli

# Veya proje bağımlılığı olarak
npm install @burgan-tech/vnext-workflow-cli

Kurulumdan sonra şu alias'lardan herhangi biri kullanılabilir:

wf --version       # kısa alias
vnext --version    # Windows için önerilen
workflow --version # tam isim

Gereksinimler

Node.js >= 14.0.0
PostgreSQL (veritabanı işlemleri için)
Docker (opsiyonel, PostgreSQL container için)

vnext.config.json (Zorunlu)

CLI, proje kök dizininde bir vnext.config.json dosyası bekler:

{
  "version": "1.0.0",
  "domain": "core",
  "paths": {
    "componentsRoot": "core",
    "tasks": "Tasks",
    "views": "Views",
    "functions": "Functions",
    "extensions": "Extensions",
    "workflows": "Workflows",
    "schemas": "Schemas"
  }
}

CLI, componentsRoot altını recursive tarar ve .json dosyalarını keşfeder (.meta klasörleri, *.diagram.json, package*.json ve *config*.json hariç).

Hızlı Başlangıç

# vNext proje dizinine git
cd /path/to/your/vnext-project

# Sistem durumunu kontrol et
wf check

# Tüm component'leri senkronize et (eksikleri ekle)
wf sync

# Değişen dosyaları güncelle
wf update

Temel Komutlar

`wf check` — Sistem Durumu

API bağlantısı, veritabanı durumu ve component klasörlerini kontrol eder.

`wf sync` — Eksik Component'leri Ekle

Veritabanında olmayan component'leri publish eder, mevcut olanları atlar. İlk kurulum ve yeni component ekleme senaryoları için idealdir.

`wf update` — Değişenleri Güncelle

Git'te değişen dosyaları tespit eder, veritabanından siler ve yeniden publish eder.

wf update                # Git'te değişen dosyaları işle
wf update --all          # Tümünü güncelle (onay sorar)
wf update --file x.json  # Tek dosya işle

`wf reset` — Zorla Sıfırla

İnteraktif menüden component tipi seçerek zorla sıfırlama yapar (sil + yeniden publish).

wf reset  # İnteraktif menü açılır

`wf csx` — CSX → Base64 Dönüşümü

CSX dosyalarını Base64'e çevirip ilgili JSON dosyalarına gömer. API'ye publish etmez.

wf csx              # Git'te değişen CSX dosyaları
wf csx --all        # Tüm CSX dosyaları
wf csx --file x.csx # Tek dosya

Komut Karşılaştırması

Komut	DB Kontrol	Mevcut Varsa	Yeni İse	Kullanım Senaryosu
`sync`	Evet	Atla	Publish	Eksik component'leri ekle
`update`	Evet	Sil + Publish	Publish	Değişenleri güncelle
`reset`	Evet	Sil + Publish	Publish	Zorla sıfırla
`csx`	Hayır	—	—	Sadece CSX→JSON güncelle

Multidomain Desteği

CLI, birden fazla domain konfigürasyonunu destekler. Her domain'in kendi API ve veritabanı ayarları olabilir.

Auto Domain Resolution

vnext.config.json içindeki domain alanı ile CLI profili otomatik eşleşir:

# Domain profilleri ekle (tek seferlik)
wf domain add core --API_BASE_URL http://localhost:4201 --DB_NAME vNext_Core
wf domain add onboarding --API_BASE_URL http://localhost:4221 --DB_NAME vNext_Onboarding

# Proje dizinine gir — domain otomatik değişir
cd ~/projects/core-app        # vnext.config.json: "domain": "core"
wf update                     # → core profili kullanılır

cd ~/projects/onboarding-app  # vnext.config.json: "domain": "onboarding"
wf update                     # → onboarding profili kullanılır

Domain Komutları

wf domain active         # Aktif domain'i göster
wf domain list           # Tüm domain'leri listele
wf domain add <name>     # Yeni domain ekle
wf domain use <name>     # Aktif domain'i değiştir
wf domain remove <name>  # Domain'i sil

Konfigürasyon

Config dosyası: ~/.config/vnext-workflow-cli/config.json

wf config get              # Tüm ayarları göster
wf config set DB_HOST localhost
wf config set USE_DOCKER true

Ayarlar Tablosu

Değişken	Varsayılan	Açıklama
`API_BASE_URL`	`http://localhost:4201`	vNext API base URL
`API_VERSION`	`v1`	API versiyonu
`DB_HOST`	`localhost`	PostgreSQL host
`DB_PORT`	`5432`	PostgreSQL port
`DB_NAME`	`vNext_WorkflowDb`	Veritabanı adı
`DB_USER`	`postgres`	Kullanıcı adı
`DB_PASSWORD`	`postgres`	Şifre
`USE_DOCKER`	`false`	Docker üzerinden PostgreSQL bağlantısı
`DOCKER_POSTGRES_CONTAINER`	`vnext-postgres`	Docker container adı
`AUTO_DISCOVER`	`true`	Otomatik component keşfi
`DEBUG_MODE`	`false`	Debug logging

Sorun Giderme

"vnext.config.json not found"

Doğru dizinde olduğunuzdan emin olun. CLI her zaman process.cwd() kullanır.

"Cannot connect to API"

curl http://localhost:4201/api/v1/health
wf config get API_BASE_URL

"Database connection failed"

docker ps | grep postgres
docker start vnext-postgres
wf config get USE_DOCKER

Tam dokümantasyon için: github.com/burgan-tech/vnext-workflow-cli

Kurulum​

Gereksinimler​

vnext.config.json (Zorunlu)​

Hızlı Başlangıç​

Temel Komutlar​

wf check — Sistem Durumu​

wf sync — Eksik Component'leri Ekle​

wf update — Değişenleri Güncelle​

wf reset — Zorla Sıfırla​

wf csx — CSX → Base64 Dönüşümü​

Komut Karşılaştırması​

Multidomain Desteği​

Auto Domain Resolution​

Domain Komutları​

Konfigürasyon​

Ayarlar Tablosu​

Sorun Giderme​

"vnext.config.json not found"​

"Cannot connect to API"​

"Database connection failed"​