-
Notifications
You must be signed in to change notification settings - Fork 0
Guide CLI Reference
Version: 3.1.0
Status: ✅ Vollständige CLI-Referenz
Diese Referenz dokumentiert alle verfügbaren CLI-Befehle von VelinScript mit allen Parametern und Optionen.
Basis-Befehl: velin
Kompiliert eine VelinScript-Datei zu einer Zielsprache.
Syntax:
velin compile -i <input> [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei (.velin) | Erforderlich |
--output |
-o |
Pfad | Ausgabe-Datei | Auto (basierend auf target) |
--target |
String | Ziel-Sprache | rust |
|
--framework |
String | Web Framework | Auto | |
--no-type-check |
Flag | Überspringe Type Checking | false |
|
--show-code |
Flag | Zeige generierten Code in Konsole | false |
|
--autofix |
Flag | Automatische Fehlerkorrektur | false |
|
--ai-semantic |
Flag | KI-Semantik-Analyse aktivieren | false |
|
--ai-bug-detection |
Flag | KI-Bug-Erkennung aktivieren | false |
|
--ai-codegen |
Flag | KI-Code-Generierung aktivieren | false |
|
--ai-optimization |
Flag | KI-Optimierung aktivieren | false |
|
--ai-provider |
String | AI Provider (openai, anthropic, gemini, local) | - | |
--ai-api-key |
String | AI API Key | - |
Ziel-Sprachen (--target):
-
rust(Standard) phppython-
typescript/ts -
javascript/js -
go/golang java-
csharp/cs
Web Frameworks (--framework):
-
axum(Rust, Standard) -
actix(Rust) -
laravel(PHP) -
symfony(PHP) -
fastapi(Python) -
flask(Python) -
express(TypeScript/JavaScript) -
nestjs(TypeScript)
Beispiele:
# Einfache Kompilierung
velin compile -i main.velin
# Mit Ausgabe-Datei
velin compile -i main.velin -o output.rs
# Für PHP
velin compile -i main.velin --target php
# Mit AutoFix
velin compile -i main.velin --autofix
# Mit KI-Features
velin compile -i main.velin \
--ai-semantic \
--ai-bug-detection \
--ai-codegen \
--ai-provider openai \
--ai-api-key $OPENAI_API_KEY
# Code in Konsole anzeigen
velin compile -i main.velin --show-code
# Ohne Type Checking (schneller)
velin compile -i main.velin --no-type-checkPrüft eine VelinScript-Datei auf Fehler (nur Parsing & Type Checking, keine Code-Generierung).
Neue Features in 3.1.0:
- ✅ Intelligente Lösungsvorschläge für alle Fehlertypen
- ✅ Separate Warnings-Anzeige
- ✅ Detaillierte Fehlerstatistiken
- ✅ Verbesserte Fehlermeldungen mit Code-Beispielen
Siehe: Fehlerbehandlung & Lösungsvorschläge ✅ (Neu in 3.1.0)
Syntax:
velin check -i <input> [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei (.velin) | Erforderlich |
--autofix |
Flag | Automatische Fehlerkorrektur | false |
Beispiele:
# Code prüfen
velin check -i main.velin
# Mit AutoFix
velin check -i main.velin --autofixFormatiert eine VelinScript-Datei.
Syntax:
velin format -i <input> [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei (.velin) | Erforderlich |
--in-place |
Flag | Überschreibe die Datei | false |
Beispiele:
# Formatierung anzeigen (ohne Datei zu ändern)
velin format -i main.velin
# Datei direkt formatieren
velin format -i main.velin --in-placeZeigt Informationen über eine VelinScript-Datei.
Syntax:
velin info -i <input>Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei (.velin) | Erforderlich |
Beispiele:
velin info -i main.velinInitialisiert ein neues VelinScript-Projekt.
Syntax:
velin init [NAME] [OPTIONS]
velin new [NAME] [OPTIONS]Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
NAME |
String | Projekt-Name | - |
--current-dir |
Flag | Erstelle im aktuellen Verzeichnis | false |
Beispiele:
# Neues Projekt erstellen
velin init my-project
# Im aktuellen Verzeichnis
velin init --current-dir
# Alias
velin new my-apiStartet einen Development-Server (kompiliert und startet die API).
Syntax:
velin serve [OPTIONS]
velin run [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei (.velin) | Auto (main.velin) |
--port |
-p |
Zahl | Port | 8080 |
--host |
String | Host | localhost |
|
--watch |
-w |
Flag | Watch-Mode (automatisches Neuladen) | false |
Beispiele:
# Server starten
velin serve
# Mit Port
velin serve -p 3000
# Mit Watch-Mode
velin serve --watch
# Alias
velin run -p 8080 --watchGeneriert OpenAPI-Spezifikation aus VelinScript-Code.
Syntax:
velin open-api -i <input> [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei (.velin) | Erforderlich |
--output |
-o |
Pfad | Ausgabe-Datei (.json oder .yaml) | Auto |
Beispiele:
# OpenAPI generieren
velin open-api -i main.velin
# Mit Ausgabe-Datei
velin open-api -i main.velin -o api.yamlGeneriert Code (Boilerplate, CRUD, etc.).
Syntax:
velin generate <TYPE> [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
TYPE |
String | Art der Generierung (api, crud, test, client) | Erforderlich | |
--name |
-n |
String | Name/Modell für die Generierung | - |
--fields |
-f |
String | Felder (für CRUD) | - |
--path |
-p |
String | Pfad (für API) | - |
--openapi |
Pfad | OpenAPI Datei (für Client) | - | |
--language |
-l |
String | Ausgabe-Sprache (für Client) | - |
--output |
-o |
Pfad | Ausgabe-Datei | - |
Generierungs-Typen:
-
api- API Boilerplatevelin generate api --name User --path /api/users
-
crud- CRUD-Operationenvelin generate crud --name Product --fields "id:string,name:string,price:number" -
test- Test-Stubsvelin generate test --name UserService -
client- API-Clientvelin generate client --openapi api.json --language typescript
Beispiele:
# API generieren
velin generate api -n User -p /api/users
# CRUD generieren
velin generate crud -n Product -f "id:string,name:string,price:number"
# Client generieren
velin generate client --openapi api.json -l typescriptFührt Tests aus (Unit + Integration).
Syntax:
velin test [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--directory |
-d |
Pfad | Test-Verzeichnis | Auto |
--unit |
Flag | Nur Unit Tests | false |
|
--integration |
Flag | Nur Integration Tests | false |
|
--verbose |
-v |
Flag | Verbose Output | false |
Beispiele:
# Alle Tests
velin test
# Nur Unit Tests
velin test --unit
# Nur Integration Tests
velin test --integration
# Verbose
velin test --verboseVerwaltet velin.config.json.
Syntax:
velin config <SUBCOMMAND>Subcommands:
Initialisiert velin.config.json.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
--example |
Flag | Verwende Beispiel-Config | false |
Beispiele:
velin config init
velin config init --exampleValidiert velin.config.json.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--file |
-f |
Pfad | Config-Datei | velin.config.json |
Beispiele:
velin config validate
velin config validate -f custom.config.jsonZeigt Config-Werte.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--file |
-f |
Pfad | Config-Datei | velin.config.json |
Beispiele:
velin config show
velin config show -f custom.config.jsonVerwaltet den Compiler-Cache.
Syntax:
velin cache <SUBCOMMAND>Subcommands:
Zeigt Cache-Statistiken.
Beispiele:
velin cache statsLeert Cache.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
PATTERN |
String | Pattern für Keys | - |
Beispiele:
# Alles leeren
velin cache clear
# Mit Pattern
velin cache clear "compiled:*"Wärmt Cache (lädt häufig verwendete Daten vor).
Beispiele:
velin cache warmVerwaltet Backups.
Syntax:
velin backup <SUBCOMMAND>Subcommands:
Erstellt ein Backup.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--strategy |
-s |
String | Backup-Strategie (full, incremental) | full |
--destination |
-d |
String | Ziel-Verzeichnis | Auto |
--compression |
-c |
String | Komprimierung (gzip, zip, none) | gzip |
Beispiele:
velin backup create
velin backup create -s incremental -c zipStellt ein Backup wieder her.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
BACKUP_ID |
String | Backup-ID | Erforderlich | |
--destination |
-d |
String | Ziel-Verzeichnis | Auto |
Beispiele:
velin backup restore backup-123
velin backup restore backup-123 -d /restore/pathListet alle Backups auf.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--directory |
-d |
String | Verzeichnis mit Backups | Auto |
Beispiele:
velin backup list
velin backup list -d /backupsLöscht ein Backup.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
BACKUP_ID |
String | Backup-ID | Erforderlich | |
--directory |
-d |
String | Verzeichnis mit Backups | Auto |
Beispiele:
velin backup delete backup-123Verifiziert ein Backup.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
BACKUP_ID |
String | Backup-ID | Erforderlich | |
--directory |
-d |
String | Verzeichnis mit Backups | Auto |
Beispiele:
velin backup verify backup-123Verwaltet Rollbacks und Versionen.
Syntax:
velin rollback <SUBCOMMAND>Subcommands:
Beginnt eine Transaktion.
Beispiele:
velin rollback beginCommittet eine Transaktion.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
TRANSACTION_ID |
String | Transaktions-ID | Erforderlich |
Beispiele:
velin rollback commit tx-123Rollback einer Transaktion.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
TRANSACTION_ID |
String | Transaktions-ID | Erforderlich |
Beispiele:
velin rollback rollback tx-123Erstellt eine Version.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
DESCRIPTION |
String | Beschreibung | Erforderlich |
Beispiele:
velin rollback create-version "Version 1.0.0"Rollback zu einer Version.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
VERSION_ID |
String | Version-ID | Erforderlich |
Beispiele:
velin rollback to-version v1.0.0Listet alle Versionen auf.
Beispiele:
velin rollback list-versionsErstellt einen Snapshot.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
DESCRIPTION |
String | Beschreibung | Erforderlich |
Beispiele:
velin rollback create-snapshot "Pre-deployment snapshot"Rollback zu einem Snapshot.
Parameter:
| Parameter | Typ | Beschreibung | Standard |
|---|---|---|---|
SNAPSHOT_ID |
String | Snapshot-ID | Erforderlich |
Beispiele:
velin rollback to-snapshot snap-123Listet alle Snapshots auf.
Beispiele:
velin rollback list-snapshotsKonvertiert und validiert JSON/YAML.
Syntax:
velin serialize <SUBCOMMAND>Subcommands:
Konvertiert JSON zu YAML.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei | Erforderlich |
--output |
-o |
Pfad | Ausgabe-Datei | Erforderlich |
Beispiele:
velin serialize json-to-yaml -i config.json -o config.yamlKonvertiert YAML zu JSON.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--input |
-i |
Pfad | Eingabe-Datei | Erforderlich |
--output |
-o |
Pfad | Ausgabe-Datei | Erforderlich |
Beispiele:
velin serialize yaml-to-json -i config.yaml -o config.jsonValidiert JSON.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--file |
-f |
Pfad | Datei | Erforderlich |
Beispiele:
velin serialize validate-json -f data.jsonValidiert YAML.
Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--file |
-f |
Pfad | Datei | Erforderlich |
Beispiele:
velin serialize validate-yaml -f config.yamlPrüft die Gesundheit eines Endpoints.
Syntax:
velin health [OPTIONS]Parameter:
| Parameter | Kurzform | Typ | Beschreibung | Standard |
|---|---|---|---|---|
--url |
-u |
String | Endpoint-URL | - |
--verbose |
-v |
Flag | Zeige detaillierte Metriken | false |
Beispiele:
velin health -u http://localhost:8080/health
velin health -u http://localhost:8080/health --verboseZeigt Hilfe-Informationen.
Beispiele:
velin --help
velin compile --help
velin config --helpZeigt Version.
Beispiele:
velin --version# OpenAI
export OPENAI_API_KEY="sk-..."
# Anthropic
export ANTHROPIC_API_KEY="sk-ant-..."
# Google Gemini
export GEMINI_API_KEY="..."# Cache-Verzeichnis
export VELIN_CACHE_DIR="/path/to/cache"
# Log-Level
export VELIN_LOG_LEVEL="debug"{
"compiler": {
"target": "rust",
"framework": "axum",
"autofix": true,
"type_check": true
},
"ai": {
"provider": "openai",
"api_key": "${OPENAI_API_KEY}"
},
"cache": {
"enabled": true,
"directory": ".velin/cache"
}
}-
Verwende
velin serve --watchfür Development -
Nutze
velin checkvor Commits -
Verwende
velin format --in-placefür konsistente Formatierung
-
Nutze
velin compilemit expliziten Targets -
Aktiviere
--ai-codegennur wenn nötig -
Verwende
velin backup createvor Deployments
- Getting Started - Erste Schritte
- API-Keys Setup - API-Keys Konfiguration
- Tools-Übersicht - Alle Tools
Letzte Aktualisierung: 2026-02-02
Version: 3.1.0
- Compiler Architecture
- Pass-Verlauf
- Type Inference
- Code Ordering
- IR Representation
- Borrow Checker
- Code Generation
- Multi-Target Compilation
- Module Resolution
- Framework Integration
- Parallelization
- AI Compiler Passes
- Prompt Optimizer
- System Generation
- Basics
- APIs
- Security
- Database
- Validation
- Authentication
- ML/LLM
- Intelligence Features
- Type Inference
- ML Training
- Pattern Matching
- Closures
- Collections
- HTTP Client
- String Interpolation
- Debugger
- Vektor-Datenbanken
- CLI Reference
- API Keys Setup
- Advanced
- Backend
- Security Best Practices
- AI/ML
- Auto Imports
- Plugin Development