Skip to content

cli-reference.md

Latest commit

 

History

History
535 lines (378 loc) · 10.9 KB

cli-reference.md

File metadata and controls

535 lines (378 loc) · 10.9 KB
Raw

CLI-Referenz

Version: 3.5.1

Dokumentiert die nutzerrelevanten CLI-Befehle. Versteckte Hilfsbefehle erscheinen nicht in velin --help.

Basis-Befehl: velin

Hauptbefehle

velin compile - Kompilierung

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; .vel Lese-Alias) 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)
  • php
  • python
  • 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-check

velin check - Code-Prüfung

Prüft eine VelinScript-Datei auf Fehler (nur Parsing & Type Checking, keine Code-Generierung).

Syntax:

velin check -i <input> [OPTIONS]

Parameter:

Parameter Kurzform Typ Beschreibung Standard
--input -i Pfad Eingabe-Datei (.velin; .vel Lese-Alias) Erforderlich
--autofix Flag Automatische Fehlerkorrektur false

Beispiele:

# Code prüfen
velin check -i main.velin

# Mit AutoFix
velin check -i main.velin --autofix

velin format - Code-Formatierung

Formatiert eine VelinScript-Datei.

Syntax:

velin format -i <input> [OPTIONS]

Parameter:

Parameter Kurzform Typ Beschreibung Standard
--input -i Pfad Eingabe-Datei (.velin; .vel Lese-Alias) 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-place

velin info - Datei-Informationen

Zeigt Informationen über eine VelinScript-Datei.

Syntax:

velin info -i <input>

Parameter:

Parameter Kurzform Typ Beschreibung Standard
--input -i Pfad Eingabe-Datei (.velin; .vel Lese-Alias) Erforderlich

Beispiele:

velin info -i main.velin

velin init / velin new - Projekt initialisieren

Initialisiert 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-api

velin serve - Axum-Scaffold

Schreibt ein lauffähiges Axum-Gerüst nach .velin/serve-scaffold/. Startet keinen HTTP-Server.

velin serve -i main.velin
cd .velin/serve-scaffold && cargo run

--watch ist nicht implementiert (ehrliche Meldung, kein Reload).

velin run - Kompilieren und Server starten

Kompiliert die Quelle nach Axum und startet den Prozess. Default-Port 8080. --host wird gebunden (Standard: 127.0.0.1).

Syntax:

velin run <DATEI> [--port 8080] [--host 127.0.0.1]

DATEI ist eine .velin-Datei. .vel wird als Lese-Alias akzeptiert; die offizielle Endung bleibt .velin.

velin run hello.velin
# GET http://127.0.0.1:8080/ping
# GET http://127.0.0.1:8080/hello?name=Velin

--watch ist nicht implementiert; der Server startet einmalig.

velin cache / health / rollback

Nicht implementiert. Die Befehle beenden mit Fehler und täuschen keinen Erfolg vor.

velin open-api - OpenAPI-Generierung

Generiert OpenAPI-Spezifikation aus VelinScript-Code.

Syntax:

velin open-api -i <input> [OPTIONS]

Parameter:

Parameter Kurzform Typ Beschreibung Standard
--input -i Pfad Eingabe-Datei (.velin; .vel Lese-Alias) 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.yaml

velin generate - Code-Generierung

Generiert 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:

  1. api - API Boilerplate

    velin generate api --name User --path /api/users

  2. crud - CRUD-Operationen

    velin generate crud --name Product --fields "id:string,name:string,price:number"

  3. test - Test-Stubs

    velin generate test --name UserService

  4. client - API-Client

    velin 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 typescript

velin test - Tests ausführen

Fü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 --verbose

Konfigurationsbefehle

velin config - Config-Verwaltung

Verwaltet velin.config.json.

Syntax:

velin config <SUBCOMMAND>

Subcommands:

velin config init

Initialisiert velin.config.json.

Parameter:

Parameter Typ Beschreibung Standard
--example Flag Verwende Beispiel-Config false

Beispiele:

velin config init
velin config init --example

velin config validate

Validiert 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.json

velin config show

Zeigt 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.json

Backup

velin backup

Sichert Projektdateien (.velin, Cargo.toml, velin.config.json) unter .velin/backup/backup-<timestamp>/.

velin backup create
velin backup list
velin backup restore backup-<id>

Hilfe & Version

velin --help / velin -h

Zeigt Hilfe-Informationen.

Beispiele:

velin --help
velin compile --help
velin config --help

velin --version / velin -V

Zeigt Version.

Beispiele:

velin --version

Umgebungsvariablen

AI-Provider-Konfiguration

# OpenAI
export OPENAI_API_KEY="sk-..."

# Anthropic
export ANTHROPIC_API_KEY="sk-ant-..."

# Google Gemini
export GEMINI_API_KEY="..."

Compiler-Konfiguration

# Cache-Verzeichnis
export VELIN_CACHE_DIR="/path/to/cache"

# Log-Level
export VELIN_LOG_LEVEL="debug"

Konfigurationsdatei

velin.config.json

{
  "compiler": {
    "target": "rust",
    "framework": "axum",
    "autofix": true,
    "type_check": true
  },
  "ai": {
    "provider": "openai",
    "api_key": "${OPENAI_API_KEY}"
  },
  "cache": {
    "enabled": true,
    "directory": ".velin/cache"
  }
}

Best Practices

Entwicklung

  1. Nutze velin run main.velin zum Starten (Port 8080). velin serve schreibt nur ein Scaffold.
  2. Nutze velin check vor Commits
  3. Verwende velin format --in-place für konsistente Formatierung

Production

  1. Nutze velin compile mit expliziten Targets
  2. Aktiviere --ai-codegen nur wenn nötig
  3. Verwende velin backup create vor riskanten Änderungen

Siehe auch

Version: 3.5.1