Skip to main content

Module headings

Module headings 

Source
Expand description

Help heading constants and taxonomy helpers for sqry CLI

This module provides a single source of truth for help text organization, ensuring consistent grouping across all commands and subcommands.

Tested with clap 4.5.x - heading behavior may change in future versions.

Constants§

ADVANCED_CONFIGURATION
Advanced configuration (cache dirs, etc.)
ALIAS_CONFIGURATION
Alias command configuration options
ALIAS_INPUT
Alias command input specification
BATCH_INPUTS
Batch command input sources
BATCH_OUTPUT_TARGETS
Batch command output targets
BATCH_SESSION_CONTROL
Batch session control and resilience
CACHE_INPUT
Cache input paths
COMMON_OPTIONS
Common options that appear across all commands
COMPLETIONS_SHELL_TARGETS
Completions shell targets
CONFIG_INPUT
Config command input specification
CYCLE_OPTIONS
Cycle detection options
DIAGRAM_CONFIGURATION
Diagram configuration and formatting
DUPLICATE_OPTIONS
Duplicate detection options
EXPORT_OPTIONS
Export format options
FILE_FILTERING
File filtering and traversal
GRAPH_ANALYSIS_INPUT
Graph analysis input targets
GRAPH_ANALYSIS_OPTIONS
Graph analysis options
GRAPH_CONFIGURATION
Graph command root-level configuration
GRAPH_FILTERING
Graph filtering and constraints
GRAPH_OUTPUT_OPTIONS
Graph output customization
HISTORY_CONFIGURATION
History command configuration options
HISTORY_INPUT
History command input specification
INDEX_CONFIGURATION
Index build configuration options
INDEX_INPUT
Index command input configuration
INDEX_MANAGEMENT
Index management operations
INSIGHTS_CONFIGURATION
Insights command configuration
INSIGHTS_OUTPUT
Insights output options
MATCH_BEHAVIOUR
Match behavior configuration (case, exact, regex)
NL_CONFIGURATION
Natural language translation configuration
NL_INPUT
Natural language query input
OUTPUT_CONTROL
Output formatting and presentation
PERFORMANCE_DEBUGGING
Performance and debugging options
PERFORMANCE_TUNING
Performance tuning for indexing and queries
PERSISTENCE_OPTIONS
Query persistence options (for –save-as on query/search)
PLUGIN_SELECTION
Plugin selection and cost-tier controls.
QUERY_INPUT
Query input specification
REPAIR_OPTIONS
Repair command options
SAFETY_CONTROL
Safety controls for destructive operations
SEARCH_INPUT
Search input specification
SEARCH_MODES
Search mode selection (fuzzy, semantic, text)
SEARCH_MODES_FUZZY
Fuzzy search configuration
SECURITY_LIMITS
Security limits for query execution (CD Static Analysis)
SHELL_CONFIGURATION
Shell command configuration
TRAVERSAL_CONTROL
Graph traversal control
UNUSED_OPTIONS
Unused code detection options
UPDATE_CONFIGURATION
Update command configuration
UTILITIES
Utilities grouping for batch and completions
VISUALIZATION_INPUT
Visualization input specification
WATCH_CONFIGURATION
Watch command configuration
WORKSPACE_CONFIGURATION
Workspace configuration options
WORKSPACE_INPUT
Workspace input paths

Functions§

apply_root_layout
Apply root-level command layout by setting subcommand headings
normalize
Normalize command for deterministic help output in tests