Skip to content

Commit 700c0fb

Browse files
jung-thomasjung-thomas
committed
feat: enhance CLI commands with documentation epilogues and examples
- Added `buildDocEpilogue` function to generate documentation links for CLI commands. - Updated `views`, `workloadManagement`, and `xsaServices` commands to include epilogues. - Introduced `examples.json` file containing usage examples for various commands. - Enhanced knowledge base documentation with updated command references and examples. - Removed obsolete `fix-hotspots.cjs` script. - Created `update-epilogues.js` script to automate the addition of documentation epilogues to command files. - Improved output format documentation and removed unnecessary pretty JSON option. - Added interactive mode features and workflows for guided command execution.
1 parent 7199ed0 commit 700c0fb

File tree

188 files changed

+3962
-333
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+3962
-333
lines changed

‎.gitignore‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,7 @@ yarn.lock
8585
#Test Results
8686
/mochawesome-report
8787

88-
/.playwright-mcp
88+
/.playwright-mcp
89+
90+
# Interactive mode state
91+
.interactive-state.json

‎_i18n/examples.properties‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
examplesCommand=Show examples for commands
2+
examplesSearch=Search examples by keyword
3+
examplesExample1=hana-cli examples
4+
examplesExample2=hana-cli example import
5+
examplesExample3=hana-cli examples search "duplicate"
6+
examplesAllTitle=Available Commands with Examples
7+
examplesAliases=Aliases
8+
examplesDescription=Description
9+
examplesCount=examples available
10+
examplesSearchResults=Examples matching your search
11+
examplesTitle=Examples
12+
examplesRelated=Also try
13+
examplesNotFound=No examples found for command

‎_i18n/examples_de.properties‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
examplesCommand=Beispiele für Befehle anzeigen
2+
examplesSearch=Beispiele nach Schlüsselwort durchsuchen
3+
examplesExample1=hana-cli examples
4+
examplesExample2=hana-cli example import
5+
examplesExample3=hana-cli examples search "duplicate"
6+
examplesAllTitle=Verfügbare Befehle mit Beispielen
7+
examplesAliases=Aliase
8+
examplesDescription=Beschreibung
9+
examplesCount=Beispiele verfügbar
10+
examplesSearchResults=Beispiele, die Ihrer Suche entsprechen
11+
examplesTitle=Beispiele
12+
examplesRelated=Probieren Sie auch
13+
examplesNotFound=Keine Beispiele für Befehl gefunden

‎_i18n/examples_es.properties‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
examplesCommand=Mostrar ejemplos de comandos
2+
examplesSearch=Buscar ejemplos por palabra clave
3+
examplesExample1=hana-cli examples
4+
examplesExample2=hana-cli example import
5+
examplesExample3=hana-cli examples search "duplicate"
6+
examplesAllTitle=Comandos Disponibles con Ejemplos
7+
examplesAliases=Alias
8+
examplesDescription=Descripción
9+
examplesCount=ejemplos disponibles
10+
examplesSearchResults=Ejemplos que coinciden con su búsqueda
11+
examplesTitle=Ejemplos
12+
examplesRelated=También probar
13+
examplesNotFound=No se encontraron ejemplos para el comando

‎_i18n/examples_fr.properties‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
examplesCommand=Afficher les exemples pour les commandes
2+
examplesSearch=Rechercher des exemples par mot-clé
3+
examplesExample1=hana-cli examples
4+
examplesExample2=hana-cli example import
5+
examplesExample3=hana-cli examples search "duplicate"
6+
examplesAllTitle=Commandes Disponibles avec Exemples
7+
examplesAliases=Alias
8+
examplesDescription=Description
9+
examplesCount=exemples disponibles
10+
examplesSearchResults=Exemples correspondant à votre recherche
11+
examplesTitle=Exemples
12+
examplesRelated=Essayer également
13+
examplesNotFound=Aucun exemple trouvé pour la commande

‎_i18n/examples_pt.properties‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
examplesCommand=Mostrar exemplos de comandos
2+
examplesSearch=Pesquisar exemplos por palavra-chave
3+
examplesExample1=hana-cli examples
4+
examplesExample2=hana-cli example import
5+
examplesExample3=hana-cli examples search "duplicate"
6+
examplesAllTitle=Comandos Disponíveis com Exemplos
7+
examplesAliases=Aliases
8+
examplesDescription=Descrição
9+
examplesCount=exemplos disponíveis
10+
examplesSearchResults=Exemplos que correspondem à sua pesquisa
11+
examplesTitle=Exemplos
12+
examplesRelated=Também tente
13+
examplesNotFound=Nenhum exemplo encontrado para o comando

‎_i18n/interactive.properties‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Interactive Mode Command
2+
interactive=Start interactive mode with guided workflows and command search
3+
presetOption=Load a saved preset configuration
4+
categoryOption=Start in a specific category
5+
interactiveExample1=Start interactive mode
6+
interactiveExample2=Start in data-tools category
7+
interactiveExample3=Load saved preset
8+
9+
# Welcome Banner
10+
welcomeBanner=HANA CLI Interactive Mode
11+
welcomeMessage=Welcome to the interactive command interface!
12+
welcomeFeature1=• Search commands, browse categories, and access guided workflows
13+
welcomeFeature2=• Save presets for frequently used command configurations
14+
welcomeFeature3=• Press Ctrl+C at any time to exit
15+
16+
# Main Menu
17+
mainMenuPrompt=What would you like to do?
18+
mainMenuSearch=🔍 Search & Run Command
19+
mainMenuCategory=📂 Browse by Category
20+
mainMenuRecent=🕐 Recent Commands
21+
mainMenuPreset=⭐ Load Preset
22+
mainMenuWorkflow=🔧 Guided Workflow
23+
mainMenuExit=❌ Exit
24+
25+
# Menu States
26+
noHistoryYet=No history yet
27+
noPresetsSaved=No presets saved
28+
29+
# Search
30+
searchPrompt=Search for a command:
31+
searchValidation=Please enter a search term
32+
searchNoResults=No commands found matching "{0}"
33+
searchFoundCommands=Found {0} command(s). Select one:
34+
35+
# Category
36+
categorySelectPrompt=Select a category:
37+
categoryCommands={0} commands
38+
categoryNoCommands=No commands in this category
39+
categorySelectCommand=Select a command from {0}:
40+
41+
# Recent Commands
42+
recentSelectPrompt=Select a recent command:
43+
recentUseSameParams=Use the same parameters?
44+
45+
# Presets
46+
presetSelectPrompt=Select a preset:
47+
presetDelete=🗑 Delete a preset
48+
presetSelectToDelete=Select preset to delete:
49+
presetDeleted=✓ Preset '{0}' deleted
50+
presetUseConfig=Use this preset configuration?
51+
presetSavePrompt=Save this configuration as a preset?
52+
presetNamePrompt=Preset name:
53+
presetNameValidation=Please enter a name
54+
presetSaved=✓ Preset '{0}' saved!
55+
56+
# Command Execution
57+
executeCommand=▶ Executing: {0}
58+
executionSuccess=✓ Command completed successfully
59+
executionFailed=✗ Command failed: {0}
60+
noParameters=No parameters required for this command
61+
noConfigurableParams=This command has no configurable parameters
62+
configureCommand=⚙ Configure {0}:
63+
commandNotFound=Command '{0}' not found
64+
commandNoHandler=Command has no handler
65+
66+
# Prompts
67+
runAnother=Run another command?
68+
exitingMessage=👋 Thanks for using hana-cli interactive mode!
69+
exitingInterrupt=👋 Exiting interactive mode...
70+
71+
# Workflows
72+
workflowSelectPrompt=Select a guided workflow:
73+
workflowImport=📥 Import Data Workflow
74+
workflowExport=📤 Export Data Workflow
75+
workflowAnalysis=🔍 Data Analysis Workflow
76+
workflowSchema=📊 Schema Comparison Workflow
77+
workflowDiagnostics=🔧 Database Diagnostics Workflow
78+
79+
# Import Workflow
80+
importWorkflowTitle=📥 Import Data Workflow
81+
importWorkflowDesc=This workflow will help you import data from CSV or Excel files.
82+
importFilePrompt=File path to import:
83+
importFileValidation=Please enter a file path
84+
importFormatPrompt=File format:
85+
importTablePrompt=Target table name:
86+
importTableValidation=Please enter a table name
87+
importSchemaPrompt=Schema name (leave empty for current schema):
88+
importMatchModePrompt=Column matching mode:
89+
importTruncatePrompt=Truncate table before import?
90+
importDryRunPrompt=Perform dry run (preview without committing)?
91+
92+
# Export Workflow
93+
exportWorkflowTitle=📤 Export Data Workflow
94+
exportWorkflowDesc=This workflow will help you export data to CSV or Excel files.
95+
exportQueryPrompt=Table name or SQL query:
96+
exportQueryValidation=Please enter a table or query
97+
exportFormatPrompt=Output format:
98+
exportFilePrompt=Output file path:
99+
exportHeaderPrompt=Include column headers?
100+
101+
# Analysis Workflow
102+
analysisWorkflowTitle=🔍 Data Analysis Workflow
103+
analysisWorkflowDesc=Choose an analysis tool to run.
104+
analysisToolPrompt=Select analysis tool:
105+
analysisDataProfile=Data Profile - Statistical analysis of table data
106+
analysisDuplicates=Duplicate Detection - Find duplicate records
107+
analysisValidator=Data Validator - Validate data quality
108+
analysisLineage=Data Lineage - Trace data dependencies
109+
110+
# Schema Workflow
111+
schemaWorkflowTitle=📊 Schema Comparison Workflow
112+
schemaWorkflowDesc=Compare schemas or clone schema structures.
113+
schemaActionPrompt=What would you like to do?
114+
schemaCompare=Compare two schemas
115+
schemaClone=Clone a schema
116+
schemaErd=Generate ERD diagram
117+
118+
# Diagnostics Workflow
119+
diagnosticsWorkflowTitle=🔧 Database Diagnostics Workflow
120+
diagnosticsWorkflowDesc=Run diagnostic checks on your database.
121+
diagnosticsToolPrompt=Select diagnostic tool:
122+
diagnosticsHealth=Health Check - Overall system health
123+
diagnosticsBlocking=Blocking - Check for locks and blocking
124+
diagnosticsLongRunning=Long Running Queries
125+
diagnosticsMemory=Memory Analysis
126+
diagnosticsExpensive=Expensive Statements
127+
128+
# Validation Messages
129+
validationRequired=This field is required

‎_i18n/interactive_de.properties‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Interactive Mode Command
2+
interactive=Interaktiven Modus mit geführten Workflows und Befehlssuche starten
3+
presetOption=Eine gespeicherte Voreinstellungskonfiguration laden
4+
categoryOption=In einer bestimmten Kategorie starten
5+
interactiveExample1=Interaktiven Modus starten
6+
interactiveExample2=In der Kategorie data-tools starten
7+
interactiveExample3=Gespeicherte Voreinstellung laden
8+
9+
# Welcome Banner
10+
welcomeBanner=HANA CLI Interaktiver Modus
11+
welcomeMessage=Willkommen bei der interaktiven Befehlsschnittstelle!
12+
welcomeFeature1=• Befehle suchen, Kategorien durchsuchen und auf geführte Workflows zugreifen
13+
welcomeFeature2=• Voreinstellungen für häufig verwendete Befehlskonfigurationen speichern
14+
welcomeFeature3=• Drücken Sie jederzeit Strg+C zum Beenden
15+
16+
# Main Menu
17+
mainMenuPrompt=Was möchten Sie tun?
18+
mainMenuSearch=🔍 Befehl suchen & ausführen
19+
mainMenuCategory=📂 Nach Kategorie durchsuchen
20+
mainMenuRecent=🕐 Letzte Befehle
21+
mainMenuPreset=⭐ Voreinstellung laden
22+
mainMenuWorkflow=🔧 Geführter Workflow
23+
mainMenuExit=❌ Beenden
24+
25+
# Menu States
26+
noHistoryYet=Noch kein Verlauf
27+
noPresetsSaved=Keine Voreinstellungen gespeichert
28+
29+
# Search
30+
searchPrompt=Nach einem Befehl suchen:
31+
searchValidation=Bitte geben Sie einen Suchbegriff ein
32+
searchNoResults=Keine Befehle gefunden, die "{0}" entsprechen
33+
searchFoundCommands={0} Befehl(e) gefunden. Wählen Sie einen aus:
34+
35+
# Category
36+
categorySelectPrompt=Wählen Sie eine Kategorie:
37+
categoryCommands={0} Befehle
38+
categoryNoCommands=Keine Befehle in dieser Kategorie
39+
categorySelectCommand=Wählen Sie einen Befehl aus {0}:
40+
41+
# Recent Commands
42+
recentSelectPrompt=Wählen Sie einen letzten Befehl:
43+
recentUseSameParams=Dieselben Parameter verwenden?
44+
45+
# Presets
46+
presetSelectPrompt=Wählen Sie eine Voreinstellung:
47+
presetDelete=🗑 Voreinstellung löschen
48+
presetSelectToDelete=Zu löschende Voreinstellung auswählen:
49+
presetDeleted=✓ Voreinstellung '{0}' gelöscht
50+
presetUseConfig=Diese Voreinstellungskonfiguration verwenden?
51+
presetSavePrompt=Diese Konfiguration als Voreinstellung speichern?
52+
presetNamePrompt=Name der Voreinstellung:
53+
presetNameValidation=Bitte geben Sie einen Namen ein
54+
presetSaved=✓ Voreinstellung '{0}' gespeichert!
55+
56+
# Command Execution
57+
executeCommand=▶ Ausführen: {0}
58+
executionSuccess=✓ Befehl erfolgreich abgeschlossen
59+
executionFailed=✗ Befehl fehlgeschlagen: {0}
60+
noParameters=Keine Parameter für diesen Befehl erforderlich
61+
noConfigurableParams=Dieser Befehl hat keine konfigurierbaren Parameter
62+
configureCommand=⚙ {0} konfigurieren:
63+
commandNotFound=Befehl '{0}' nicht gefunden
64+
commandNoHandler=Befehl hat keinen Handler
65+
66+
# Prompts
67+
runAnother=Einen weiteren Befehl ausführen?
68+
exitingMessage=👋 Vielen Dank, dass Sie den hana-cli interaktiven Modus verwendet haben!
69+
exitingInterrupt=👋 Interaktiver Modus wird beendet...
70+
71+
# Workflows
72+
workflowSelectPrompt=Wählen Sie einen geführten Workflow:
73+
workflowImport=📥 Datenimport-Workflow
74+
workflowExport=📤 Datenexport-Workflow
75+
workflowAnalysis=🔍 Datenanalyse-Workflow
76+
workflowSchema=📊 Schema-Vergleichs-Workflow
77+
workflowDiagnostics=🔧 Datenbankdiagnose-Workflow
78+
79+
# Import Workflow
80+
importWorkflowTitle=📥 Datenimport-Workflow
81+
importWorkflowDesc=Dieser Workflow hilft Ihnen beim Importieren von Daten aus CSV- oder Excel-Dateien.
82+
importFilePrompt=Dateipfad zum Importieren:
83+
importFileValidation=Bitte geben Sie einen Dateipfad ein
84+
importFormatPrompt=Dateiformat:
85+
importTablePrompt=Zieltabellenname:
86+
importTableValidation=Bitte geben Sie einen Tabellennamen ein
87+
importSchemaPrompt=Schemaname (leer lassen für aktuelles Schema):
88+
importMatchModePrompt=Spaltenabgleichsmodus:
89+
importTruncatePrompt=Tabelle vor dem Import leeren?
90+
importDryRunPrompt=Probelauf durchführen (Vorschau ohne Festschreibung)?
91+
92+
# Export Workflow
93+
exportWorkflowTitle=📤 Datenexport-Workflow
94+
exportWorkflowDesc=Dieser Workflow hilft Ihnen beim Exportieren von Daten in CSV- oder Excel-Dateien.
95+
exportQueryPrompt=Tabellenname oder SQL-Abfrage:
96+
exportQueryValidation=Bitte geben Sie eine Tabelle oder Abfrage ein
97+
exportFormatPrompt=Ausgabeformat:
98+
exportFilePrompt=Ausgabedateipfad:
99+
exportHeaderPrompt=Spaltenüberschriften einschließen?
100+
101+
# Analysis Workflow
102+
analysisWorkflowTitle=🔍 Datenanalyse-Workflow
103+
analysisWorkflowDesc=Wählen Sie ein Analysetool aus.
104+
analysisToolPrompt=Analysetool auswählen:
105+
analysisDataProfile=Datenprofil - Statistische Analyse von Tabellendaten
106+
analysisDuplicates=Duplikaterkennung - Doppelte Datensätze finden
107+
analysisValidator=Datenvalidator - Datenqualität validieren
108+
analysisLineage=Datenherkunft - Datenabhängigkeiten verfolgen
109+
110+
# Schema Workflow
111+
schemaWorkflowTitle=📊 Schema-Vergleichs-Workflow
112+
schemaWorkflowDesc=Schemas vergleichen oder Schemastrukturen klonen.
113+
schemaActionPrompt=Was möchten Sie tun?
114+
schemaCompare=Zwei Schemas vergleichen
115+
schemaClone=Schema klonen
116+
schemaErd=ERD-Diagramm generieren
117+
118+
# Diagnostics Workflow
119+
diagnosticsWorkflowTitle=🔧 Datenbankdiagnose-Workflow
120+
diagnosticsWorkflowDesc=Diagnosetests für Ihre Datenbank ausführen.
121+
diagnosticsToolPrompt=Diagnosetool auswählen:
122+
diagnosticsHealth=Integritätsprüfung - Allgemeine Systemintegrität
123+
diagnosticsBlocking=Blockierung - Auf Sperren und Blockierung prüfen
124+
diagnosticsLongRunning=Lang laufende Abfragen
125+
diagnosticsMemory=Speicheranalyse
126+
diagnosticsExpensive=Teure Anweisungen
127+
128+
# Validation Messages
129+
validationRequired=Dieses Feld ist erforderlich

0 commit comments

Comments
 (0)