๐ ๐ A-Commands
ADD
Development & Testing
ADD - Addon Function Call
Loads a `.py` or `.pyd` file from the `addon` folder, calls one of its functions,
and stores the return value in a variable.
Usage:
ADD variable|addon_file|function|argument1|argument2|...
Examples:
ADD result|BigBen|calculate|10|20
ADD status|SPS.py|check_status
Notes:
The addon filename may be written with or without `.py` or `.pyd`.
๐ Usage:
ADD variable|addon_file|function|argument1|argument2|...
๐ก Examples:
ADD result|BigBen|calculate|10|20
ADD status|SPS.py|check_status
๐ Pro Tips:
Call functions from Python libraries. Auto-imports modules as needed.
ANY
Input & Output
ANY - Wait for Any Key Press (โณ)
Pauses script execution and waits for the user to press any key before continuing.
Displays a prompt message and captures the keypress without displaying it.
Usage:
ANY
Behavior:
โข Displays "Press any key to continue..." message
โข Waits indefinitely until any key is pressed
โข Does not echo the pressed key to console
โข Handles Ctrl+C and EOF gracefully
Use Cases:
โข Pause script execution for user review
โข Wait before proceeding to next step
โข Interactive script flow control
โข Debugging breakpoints in scripts
Examples:
LOG Starting process...
ANY # Wait for user confirmation
LOG Process continuing...
LOG Check the output above
ANY # Pause to review
CLS # Clear and continue
Notes:
โข Windows-specific (uses msvcrt module)
โข Pressing Ctrl+C will interrupt gracefully
โข Any key works: space, enter, letters, etc.
๐ Usage:
ANY
๐ก Examples:
ANY # Wait for user confirmation
ANY # Pause to review
๐ Pro Tips:
Randomly selects from comma-separated list. Useful for random choices.
APT
Network & Communication
APT - Application Package Tool (๐ฆ)
Provides commands to install, remove, search, and show applications in the package system.
Usage:
APT INSTALL|AppName - Install an application
APT REMOVE|AppName - Remove an application
APT SEARCH|[pattern] - Search for applications (use | as wildcard for all)
APT SHOW|[pattern] - List installed apps (use | as wildcard for all)
Examples:
APT INSTALL|notepad
APT SEARCH| - Show all available apps in catalog
APT SHOW| - Show all installed apps
EXAMPLES:
APT install|notepad++ # Application package management commands.
APT search|browser
APT remove|old_app
APT show|
๐ Usage:
APT INSTALL|AppName - Install an application
๐ก Examples:
APT INSTALL|notepad
APT SEARCH| - Show all available apps in catalog
APT SHOW| - Show all installed apps
๐ Pro Tips:
Package manager for Fluxionix applications. Use "APT SEARCH|" to list all available apps.
AUT
System & Performance
AUT - Check admin status (๐)
Stores 'true' (if admin) or 'false' (if not admin) in the given variable.
Usage:
AUT variable_name
Example:
AUT isAdmin # Sets the variable isAdmin to 'true' or 'false'\n\nEXAMPLES:\n AUT isAdmin # Check admin/authentication status and store result in variable.\n AUT hasPermissions \n AUT adminStatus \n
๐ Usage:
AUT variable_name
๐ก Examples:
AUT isAdmin # Sets the variable isAdmin to 'true' or 'false'\n\nEXAMPLES:\n AUT isAdmin # Check admin/authentication status and store result in variable.\n AUT hasPermissions \n AUT adminStatus \n
๐ Pro Tips:
Some commands may require administrator privileges
๐ ๐ B-Commands
BIN
Math
BIN - Convert Number to Binary
Converts numeric input to a binary string.
USAGE:
BIN value
BIN target|value
INPUT SUPPORT:
Decimal: 42
Hex: 0x2A, 2Ah, 2A
Binary: 0b101010, 101010b
EXAMPLES:
BIN 255
BIN out|0xFF
BIN out|42
๐ Usage:
BIN value
๐ก Examples:
BIN 255
BIN out|0xFF
BIN out|42
๐ Pro Tips:
Check the documentation for advanced usage patterns
BMK
System
BMK - Advanced System Benchmark & Performance Analysis
Comprehensive benchmarking suite with strict performance criteria, bottleneck detection,
and detailed system analysis. Designed to identify performance issues and optimization opportunities.
USAGE:
BMK - Quick benchmark with overall score (2 minutes)
BMK BENCHMARK_TYPE - Run specific benchmark type
BENCHMARK TYPES:
quick, fast - Quick validation with overall score (2 minutes)
full, complete - Complete system analysis (10-15 minutes)
strict, enterprise - Enterprise-grade strict benchmarking
system, hardware - Hardware detection and analysis
memory, ram - Memory performance and latency tests
cpu, processor - CPU performance and multi-threading
disk, storage, io - Storage I/O performance (includes HDD detection)
network, net - Network performance and latency
stress, torture - Extreme stress testing (use carefully!)
bottleneck, analysis - Bottleneck detection and recommendations
STRICT PERFORMANCE RATINGS (Updated for Modern Systems):
S+ EXCEPTIONAL - Top-tier performance (95%+) - Flagship systems
S OUTSTANDING - Excellent performance (85%+) - High-end systems
A+ VERY GOOD - Strong performance (75%+) - Good gaming/work systems
A GOOD - Solid performance (65%+) - Mid-range systems
B+ AVERAGE - Acceptable performance (50%+) - Budget systems
B BELOW AVERAGE - Needs improvement (35%+) - Older systems
C+ POOR - Significant issues (25%+) - Very old hardware
C UNACCEPTABLE - Critical performance issues (<25%) - Replace needed
F FAILURE - System failure or critical bottlenecks
HDD PENALTY: Systems with HDDs automatically receive lower scores due to storage bottlenecks.
BOTTLENECK DETECTION:
๐ด Critical bottlenecks requiring immediate attention
๐ Major performance limitations
๐ก Minor optimization opportunities
๐ข Well-balanced system
OVERALL SYSTEM SCORE:
Weighted composite score considering all components
Identifies primary and secondary bottlenecks
Provides specific upgrade recommendations
Compares against modern system standards
EXAMPLES:
BMK # Quick benchmark with overall score
BMK full # Complete system analysis
BMK strict # Enterprise-grade benchmarking
BMK bottleneck # Bottleneck analysis only
BMK storage # Detect HDD vs SSD performance
FEATURES:
๐ Overall system score (0-100)
๐ฏ Bottleneck identification and ranking
๐ Performance trend analysis
๐ก Specific upgrade recommendations
โ ๏ธ HDD performance warnings
๐ Component-level analysis
๐ Detailed performance report
๐ Performance tier classification
๐ Usage:
BMK - Quick benchmark with overall score (2 minutes)
๐ก Examples:
BMK # Quick benchmark with overall score
BMK full # Complete system analysis
BMK strict # Enterprise-grade benchmarking
BMK bottleneck # Bottleneck analysis only
BMK storage # Detect HDD vs SSD performance
๐ Pro Tips:
Run benchmarks when system is idle for accurate results. Use "BMK strict" for enterprise evaluation.
BRK
Control Flow & Logic
BRK - Break Command
Breaks out of the current loop (FOR, WHI) or aborts the current execution.
Usage:
BRK
๐ Usage:
BRK
๐ก Examples:
BRK example_parameter
๐ Pro Tips:
Breaks out of current loop. Can be conditional with comparison operators.
๐ ๐ C-Commands
CAL
Variables & Data Processing
CAL - Calculator
Calculates one operation and stores the result as text.
Usage:
CAL result|value1|operator|value2
CAL variable|operator|value
Operators:
+, -, *, /, %, ^, **
Examples:
CAL result|10|+|5
CAL total|%price%|*|%quantity%
CAL counter|+|1
CAL power|2|^|8
๐ Usage:
CAL result|value1|operator|value2
๐ก Examples:
CAL result|10|+|5
CAL total|%price%|*|%quantity%
CAL counter|+|1
CAL power|2|^|8
๐ Pro Tips:
Supports basic arithmetic operators: +, -, *, /, %, **. Variables are auto-converted to numbers.
CHR
String
CHR - Character from Code Point
Converts a numeric code point to a single character.
USAGE:
CHR codepoint
CHR target|codepoint
CHR codepoint|target
EXAMPLES:
CHR 157
CHR symbol|157
CHR 157|symbol
CHR letter|%num%
๐ Usage:
CHR codepoint
๐ก Examples:
CHR 157
CHR symbol|157
CHR 157|symbol
CHR letter|%num%
๐ Pro Tips:
Check the documentation for advanced usage patterns
CLS
Input & Output
CLS - Clear Screen (๐งน)
Clears the console window (cls on Windows, clear on Linux/Mac).
Usage:
CLS
Examples:
CLS # Clear the active terminal
๐ Usage:
CLS
๐ก Examples:
CLS # Clear the active terminal
๐ Pro Tips:
Clears console. Works on Windows (cls) and Unix-like systems (clear).
CMD
General
CMD - Execute Shell Command (๐ป)
Executes system shell commands directly from the script.
Supports variable substitution and cross-platform commands.
Usage:
CMD command [arguments]
Features:
โข Direct system command execution
โข Variable substitution support
โข Pipe and redirection support
โข Cross-platform compatibility
โข Output displayed in console
Platform-Specific Commands:
Windows:
CMD dir # List directory contents
CMD tasklist | findstr python # Find Python processes
CMD ipconfig /all # Network configuration
CMD echo %PATH% # Show PATH variable
Linux/Mac:
CMD ls -la # List directory contents
CMD ps aux | grep python # Find Python processes
CMD ifconfig # Network configuration
CMD echo $PATH # Show PATH variable
Common Examples:
CMD ping google.com -n 4 # Ping with 4 packets
CMD mkdir new_folder # Create directory
CMD curl https://api.example.com # Make HTTP request
CMD %custom_command% # Execute from variable
CMD git status # Check git repository status
CMD python script.py # Run Python script
CMD npm install # Install npm packages
With Variables:
SET server|example.com
CMD ping %server% # Ping server from variable
SET path|C:\\Projects
CMD cd %path% && dir # Navigate and list
Notes:
โข Command output goes to console directly
โข Return codes are not captured
โข Commands run in system shell environment
โข Use appropriate shell syntax for your OS
โข For complex commands, consider using script files
โข Pipes (|) and redirections (>, <) are supported
๐ Usage:
CMD command [arguments]
๐ก Examples:
CMD ping google.com -n 4 # Ping with 4 packets
CMD mkdir new_folder # Create directory
CMD curl https://api.example.com # Make HTTP request
CMD %custom_command% # Execute from variable
CMD git status # Check git repository status
๐ Pro Tips:
Executes system commands. Output is captured and can be stored in variables.
CNT
General
CNT - Continue Command
Skips the remaining commands in the current loop iteration and continues to the next iteration.
Usage:
CNT
Examples:
FOR i|1|10
IFC %i%|==|5::CNT::END
LOG Counter: %i%
LOG This won't show for i=5
NXT
WHI %running%|==|true
INP user_input|Enter command:
IFC %user_input%|==|skip::CNT::END
LOG Processing: %user_input%
WND
The CNT command works in:
โข FOR loops (with NXT)
โข WHI loops (with WND)
Note: CNT only works inside loops. Outside of loops, it has no effect.
๐ Usage:
CNT
๐ก Examples:
IFC %i%|==|5::CNT::END
๐ Pro Tips:
Check the documentation for advanced usage patterns
CRF
File & Directory Operations
CRF - Create Folder (๐)
Creates a new folder (directory) at the specified path.
Automatically creates parent directories if they don't exist.
Usage:
CRF folder_path
Features:
โข Creates single or nested directory structures
โข Safe: Won't fail if folder already exists
โข Creates parent directories automatically
โข Variable substitution support
โข Cross-platform path handling
Examples:
Simple Folder:
CRF new_folder # Create in current directory
CRF data # Create 'data' folder
Nested Directories:
CRF projects\\python\\scripts # Create nested structure (Windows)
CRF projects/python/scripts # Create nested structure (Linux/Mac)
CRF C:\\Users\\John\\Documents\\Work # Full path (Windows)
With Variables:
SET project|MyApp
CRF %project% # Create folder from variable
CRF %project%\\data # Create subfolder
CRF %project%\\logs
Build Directory Structure:
CRF src\\components
CRF src\\utils
CRF tests\\unit
CRF tests\\integration
Common Use Cases:
Project Setup:
CRF MyProject\\src
CRF MyProject\\docs
CRF MyProject\\tests
Data Organization:
CRF data\\input
CRF data\\output
CRF data\\backups
Notes:
โข No error if folder already exists (safe to run multiple times)
โข All parent directories created automatically
โข Use backslashes (\\) for Windows, forward slashes (/) for Linux/Mac
โข Relative or absolute paths supported
โข Permissions inherited from parent directory
๐ Usage:
CRF folder_path
๐ก Examples:
CRF new_folder # Create in current directory
CRF data # Create 'data' folder
CRF projects\\python\\scripts # Create nested structure (Windows)
CRF projects/python/scripts # Create nested structure (Linux/Mac)
CRF C:\\Users\\John\\Documents\\Work # Full path (Windows)
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
CRY
General
CRY - Encrypt Value
Encrypts values with Fluxionix built-in encryption (no external crypto dependency).
Usage:
CRY variable|plain_text
CRY variable|plain_text|must_contain
CRY plain_text
Notes:
- Stored tokens use ASS2 prefix.
- Existing legacy ASS tokens are still decryptable by helper functions.
๐ Usage:
CRY variable|plain_text
๐ก Examples:
CRY example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ ๐ D-Commands
DAT
Utilities & Helpers
DAT - Date
Gets the current date and stores it in a variable. You can specify the date format.
USAGE:
DAT Variable|[Format]
DEFAULT FORMAT:
%d.%m.%Y
EXAMPLES:
DAT today|%d.%m.%Y # today = "16.08.2025"
DAT timestamp|%Y-%m-%d %H:%M:%S # timestamp = "2025-08-16 15:30:45"
DAT year|%Y # year = "2025"
DAT month|%m # month = "08"
DAT custom_date|%A, %B %d, %Y # custom_date = "Friday, August 16, 2025"
๐ Usage:
DAT Variable|[Format]
๐ก Examples:
DAT today|%d.%m.%Y # today = "16.08.2025"
DAT timestamp|%Y-%m-%d %H:%M:%S # timestamp = "2025-08-16 15:30:45"
DAT year|%Y # year = "2025"
DAT month|%m # month = "08"
DAT custom_date|%A, %B %d, %Y # custom_date = "Friday, August 16, 2025"
๐ Pro Tips:
Format codes: %d=day, %m=month, %Y=year, %H=hour, %M=minute, %S=second.
DBG
Development & Testing
DBG - Debug Information
Shows debug and interpreter information about Fluxionix, including version, debug mode, logging, cache, variables, and error history.
Usage:
DBG INFO # General debug information
DBG VARS # Show all user-defined variables
DBG ERRORS # Show last error
DBG EXPORT [filename]# Export debug info to file
DBG CLEAR [target] # Clear cache, variables, stats, or errors
DBG TRACE [ON|OFF] # Enable/disable debug tracing
DBG MEMORY # Show memory usage info
Available targets for CLEAR: CACHE, VARS, STATS, ERRORS\n\nEXAMPLES:\n DBG on # Toggle debug mode for detailed execution information.\n DBG off \n DBG status \n
๐ Usage:
DBG INFO
๐ก Examples:
\n DBG on # Toggle debug mode for detailed execution information.\n DBG off \n DBG status \n
๐ Pro Tips:
Debug mode shows detailed execution information. Toggle with "on"/"off".
DBQ
Data Formats & Apis
DBQ - Database Query (clear usage, no SQI required)
DBQ supports SQL Server and SQLite in one command.
SQI is optional. DBQ can auto-detect common local SQL Server instances.
Usage:
DBQ target|query|[output_variable]
DBQ query
FASTEST AND MOST CLEAR FORMAT:
DBQ target|query|[output_var]
TARGET RULES:
- SQL Server: target = database name
Example: DBQ sps|SELECT * FROM items
- SQLite: target = .db file path
Example: DBQ data.db|SELECT * FROM items
OPTIONAL OUTPUT VARIABLE:
- If output_var is set:
- SELECT: plain text row-array is stored in output_var[index]
and also output_var[index][Column]
- INSERT/UPDATE/DELETE: affected rows count is stored
EXAMPLES:
SQL Server (without SQI):
DBQ sps|SELECT TOP 10 * FROM items
DBQ sps|SELECT * FROM items|items_json
LOG %items_json[1]%
SQLite:
DBQ mydata.db|SELECT * FROM items
DBQ mydata.db|UPDATE items SET price=10|rows_changed
Query-only mode (uses context):
DBQ SELECT * FROM items
SQL SERVER NOTES:
- Credentials from context: SQLUSER, SQLPASS
- Server from context if present: SQLCOM / SQLCOMM / SQLIP
- If server is missing, DBQ tries common local instances automatically
RESULT VARIABLES ALWAYS AVAILABLE:
- db_result_json
- db_result_count
- db_affected_rows
- db_last_insert_id
ARRAY OUTPUT NOTES (for output_var in SELECT):
- output_var[0] = row count
- output_var[1] = first row as plain text (e.g. id=1 | name=Box A)
- output_var[1][id] = first row, column id
๐ Usage:
DBQ target|query|[output_variable]
๐ก Examples:
DBQ sps|SELECT * FROM items
๐ Pro Tips:
Check the documentation for advanced usage patterns
DEC
Math
DEC - Convert Number to Decimal
Converts binary or hexadecimal input to a decimal string.
USAGE:
DEC value
DEC target|value
INPUT SUPPORT:
Binary: 0b1010, 1010b, 1010
Hex: 0xFF, FFh, FF
EXAMPLES:
DEC 0b1010
DEC n|FF
DEC out|0x1A
๐ Usage:
DEC value
๐ก Examples:
DEC 0b1010
DEC n|FF
DEC out|0x1A
๐ Pro Tips:
Check the documentation for advanced usage patterns
DNL
Network & Communication
DNL - Download
Downloads a file from a specified URL with progress tracking and validation.
Usage:
DNL filename|url
DNL filename url\n\nEXAMPLES:\n DNL https://example.com/file.pdf|downloads\file.pdf # Download files from URLs with resume capability.\n DNL https://github.com/user/repo/archive/main.zip|temp\\n DNL %file_url%|%local_path% \n
๐ Usage:
DNL filename|url
๐ก Examples:
\n DNL https://example.com/file.pdf|downloads\file.pdf # Download files from URLs with resume capability.\n DNL https://github.com/user/repo/archive/main.zip|temp\\n DNL %file_url%|%local_path% \n
๐ Pro Tips:
Downloads with resume capability. Creates target directory if it doesn't exist.
DOC
Development
๐ DOC - Documentation Generator
Generates comprehensive documentation for all Fluxionix commands and functions.
USAGE:
DOC [FORMAT] [OUTPUT_FILE]
FORMATS:
๐ HTML - Interactive HTML documentation (default)
๐ TXT - Plain text documentation
๐ฅ QUICK - Quick reference
EXAMPLES:
DOC HTML docs.html
DOC TXT manual.txt
DOC QUICK
FEATURES:
โข Interactive HTML with search functionality
โข Plain text output for console viewing
โข Command categorization and examples
๐ Usage:
DOC [FORMAT] [OUTPUT_FILE]
๐ก Examples:
DOC HTML docs.html
DOC TXT manual.txt
DOC QUICK
๐ Pro Tips:
Generates comprehensive documentation in HTML or TXT format.
๐ ๐ E-Commands
END
Control Flow & Logic
END - End / Return
Closes a multiline IFC block. Inside a SUB or keyboard callback, END returns
from the current routine.
Usage:
END
Examples:
IFC %ready%|=|1
LOG Ready
END
SUB cleanup
END # Return from the current subroutine
๐ Usage:
END
๐ก Examples:
END
๐ Pro Tips:
Terminates script execution. Use exit codes: 0=success, 1=error.
๐ ๐ F-Commands
FID
File & Directory Operations
FID - File Selection Dialog
Opens a native file picker and stores the selected path in a variable. If the
dialog is cancelled, the variable is set to an empty string.
Usage:
FID [variable|title|extension_pattern]
Examples:
FID # Store the selection in %last_file%
FID document|Open document|*.txt # Store a text-file selection in %document%
FID image|Choose image|*.png;*.jpg # Allow multiple file patterns
๐ Usage:
FID [variable|title|extension_pattern]
๐ก Examples:
FID # Store the selection in %last_file%
FID document|Open document|*.txt # Store a text-file selection in %document%
FID image|Choose image|*.png;*.jpg # Allow multiple file patterns
๐ Pro Tips:
Finds files and directories by name. Returns full paths for found items.
FIE
File & Directory Operations
FIE - File Exists
Stores `true` or `false` depending on whether a file exists.
Usage:
FIE variable|filepath
Examples:
FIE config_exists|config.txt
FIE editor_exists|C:\Windows\System32\notepad.exe
๐ Usage:
FIE variable|filepath
๐ก Examples:
FIE config_exists|config.txt
FIE editor_exists|C:\Windows\System32\notepad.exe
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
FIL
Files
FIL - File Management
Performs advanced file management operations: copy, move, delete, rename, attributes, size, date, permissions.
USAGE:
FIL action|file|[target]|[options]
ACTIONS:
COPY, MOVE, DELETE, RENAME, ATTRIBUTES, SIZE, DATE, PERMISSIONS
EXAMPLES:
FIL documents|C:\\\\Users\\\\%USERNAME%\\\\Documents
FIL temp_files|*.tmp
FIL config_file|settings.ini
FIL project_files|*.py
๐ Usage:
FIL action|file|[target]|[options]
๐ก Examples:
FIL documents|C:\\\\Users\\\\%USERNAME%\\\\Documents
FIL temp_files|*.tmp
FIL config_file|settings.ini
FIL project_files|*.py
๐ Pro Tips:
Supports wildcards (*,?). Use absolute paths to avoid confusion.
FIN
General
FIN - FIND TEXT IN FILE (๐)
Searches for text or patterns in files or directories. Supports regex, case-insensitive, and directory search.
USAGE:
FIN pattern|file|[flags]
FLAGS:
i = ignore case (case-insensitive search)
r = regex (use regular expressions for searching)
d = directory search (search all files in a directory)
If you provide a folder as the file argument and use the d flag (e.g. FIN pattern|folder|d), FIN will search for the pattern in all files within that folder (recursively).
You can combine flags, e.g. 'ir' for case-insensitive regex search.
EXAMPLES:
FIN error|logfile.txt # Find "error" in logfile.txt
FIN TODO|*.py|i # Find "TODO" in all .py files (ignore case)
FIN function|source_code|r # Find "function" using regex in source_code
FIN \\d{4}|data.txt|ir # Find 4 digits, case-insensitive regex
FIN exception|C:\\Logs|d # Find "exception" in all files in C:\\Logs
๐ Usage:
FIN pattern|file|[flags]
๐ก Examples:
FIN error|logfile.txt # Find "error" in logfile.txt
FIN TODO|*.py|i # Find "TODO" in all .py files (ignore case)
FIN function|source_code|r # Find "function" using regex in source_code
FIN \\d{4}|data.txt|ir # Find 4 digits, case-insensitive regex
FIN exception|C:\\Logs|d # Find "exception" in all files in C:\\Logs
๐ Pro Tips:
Use flags: i=ignore case, r=regex, d=directory search. Combine flags like "ir".
FOD
File & Directory Operations
FOD - Folder Dialog (๐)
Opens a graphical folder selection dialog and stores the selected path in a variable.
User-friendly way to let users browse and select directories.
Usage:
FOD [variable|title]
FOD [variable]
FOD
Parameters:
variable - Variable name to store selected path (default: 'last_folder')
title - Dialog window title (default: 'Select Folder')
Features:
โข Native OS folder browser dialog
โข Stores full absolute path
โข Empty string if user cancels
โข Custom variable name support
โข Custom dialog title
โข Cross-platform compatible
Examples:
Basic Usage:
FOD # Store in 'last_folder' variable
LOG Selected: %last_folder%
Custom Variable:
FOD backup_dir # Store in 'backup_dir' variable
LOG Backup path: %backup_dir%
Custom Variable and Title:
FOD project_path|Select Project Root
LOG Project: %project_path%
FOD output_dir|Choose Output Location
CRF %output_dir%\\results
Practical Examples:
Select Backup Location:
FOD backup_location|Select Backup Folder
IFC %backup_location%|==|
LOG No folder selected!
QUT
FIL
LOG Backing up to: %backup_location%
Choose Work Directory:
FOD work_dir|Select Working Directory
SET original_dir|%CD%
CMD cd %work_dir%
# Do work here...
CMD cd %original_dir%
Variable Contents:
โข Selected path: Full absolute path (e.g., C:\\Users\\John\\Documents)
โข User cancelled: Empty string ""
Notes:
โข Dialog is modal (blocks script execution until user responds)
โข Returns empty string if user clicks Cancel
โข Path always uses OS-appropriate separators
โข Variable can be used immediately after dialog closes
โข Works on Windows, Linux (with Tkinter), and Mac
๐ Usage:
FOD [variable|title]
๐ก Examples:
FOD # Store in 'last_folder' variable
FOD backup_dir # Store in 'backup_dir' variable
FOD project_path|Select Project Root
FOD output_dir|Choose Output Location
๐ Pro Tips:
Creates directories recursively if they don't exist. Use forward slashes for cross-platform compatibility.
FOE
File & Directory Operations
FOE - Folder Exists
Checks if a specified folder exists and stores the result (true/false) in a variable.
Usage:
FOE var|folderpath
๐ Usage:
FOE var|folderpath
๐ก Examples:
FOE example_parameter
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
FOR
Control Flow & Logic
FOR - For Loop
Creates a FOR loop. Iterates over a range and executes a block of commands.
Usage:
FOR Variable|Start|End|[Step]\n\nEXAMPLES:\n FOR i|1|10::LOG Processing item %i%::NXT i\n FOR file|*.txt::LOG Found: %file%::NXT file\n FOR x|1|5::CAL result|%x%|*|2::LOG %x% * 2 = %result%::NXT x\n
๐ Usage:
FOR Variable|Start|End|[Step]\n\nEXAMPLES:\n FOR i|1|10::LOG Processing item %i%::NXT i\n FOR file|*.txt::LOG Found: %file%::NXT file\n FOR x|1|5::CAL result|%x%|*|2::LOG %x% * 2 = %result%::NXT x\n
๐ก Examples:
\n FOR i|1|10::LOG Processing item %i%::NXT i\n FOR file|*.txt::LOG Found: %file%::NXT file\n FOR x|1|5::CAL result|%x%|*|2::LOG %x% * 2 = %result%::NXT x\n
๐ Pro Tips:
Use :: as separator between loop parts. Supports file wildcards and numeric ranges.
๐ ๐ G-Commands
GEL
File & Directory Operations
GEL - Get Line Number
Finds the line number where specified content appears in a file and stores it in a variable.
Usage:
GEL Variable|File|Content
๐ Usage:
GEL Variable|File|Content
๐ก Examples:
GEL example_parameter
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
GET
Variables & Data Processing
GET - Command Execution & Output Capture
Intelligent command execution system with advanced output processing,
cross-platform compatibility, and comprehensive error handling.
USAGE:
GET variable|command # Execute command, store output in variable
GET variable|command|encoding # Specify custom encoding
GET variable|command|encoding|timeout # With timeout (seconds)
๐ฏ ADVANCED FEATURES:
โข ๐ Cross-platform command execution (Windows/Linux/macOS)
โข ๐ง Intelligent encoding detection (UTF-8, CP1252, system default)
โข โฑ๏ธ Configurable timeout protection
โข ๐ก๏ธ Comprehensive error handling and logging
โข ๐ Output processing and normalization
โข ๐จ ANSI color code stripping for clean output
โข ๐ Command validation and security checks
โข ๐ Execution history and performance tracking
โ๏ธ ENCODING OPTIONS:
utf-8 - Unicode UTF-8 (default, recommended)
cp1252 - Windows Western European
ascii - Basic ASCII
latin1 - Latin-1/ISO-8859-1
auto - Automatic detection
๐ EXAMPLES:
GET username|whoami # Get current username
GET disk_space|df -h # Get disk usage (Linux/macOS)
GET disk_space|dir C: /-c # Get directory info (Windows)
GET processes|ps aux # List processes (Linux/macOS)
GET processes|tasklist # List processes (Windows)
GET date_time|date # Current date/time
GET python_version|python --version # Python version
GET network_info|ipconfig /all # Network configuration (Windows)
GET network_info|ifconfig -a # Network configuration (Linux/macOS)
GET file_count|find . -type f | wc -l # Count files in directory
GET git_status|git status --porcelain # Git repository status
๐ฏ PLATFORM-SPECIFIC EXAMPLES:
Windows:
GET system_info|systeminfo
GET services|sc query state= all
GET installed_programs|wmic product get name
Linux/macOS:
GET memory_info|free -h
GET cpu_info|lscpu
GET process_tree|pstree
Cross-platform:
GET current_directory|pwd
GET environment|env
GET python_path|which python
๐ก PRO TIPS:
โข Commands run in the current working directory
โข Output is automatically trimmed of newlines and carriage returns
โข Use full paths for executables to avoid PATH issues
โข Combine with SET for variable processing: SET clean_output|%raw_output%
โข Chain commands with && or || for complex operations
โข Use timeout for potentially long-running commands
โข Escape special characters with quotes: GET output|"echo 'Hello World'"
๐ก๏ธ SECURITY FEATURES:
โข Command validation to prevent injection attacks
โข Timeout protection against hanging processes
โข Error logging for debugging and security auditing
โข Safe execution environment with limited privileges
โ ๏ธ IMPORTANT NOTES:
โข Commands execute with current user privileges
โข Network commands may require internet connectivity
โข Some system commands may need administrator/root privileges
โข Always validate command output before using in scripts
๐ Usage:
GET variable|command
๐ก Examples:
GET username|whoami # Get current username
GET disk_space|df -h # Get disk usage (Linux/macOS)
GET disk_space|dir C: /-c # Get directory info (Windows)
GET processes|ps aux # List processes (Linux/macOS)
GET processes|tasklist # List processes (Windows)
๐ Pro Tips:
Command output is automatically trimmed. Use single quotes around complex commands.
GOT
Control Flow & Logic
GOT - Go To
Usage:
GOT line_number
GOT label
๐ Usage:
GOT line_number
๐ก Examples:
GOT example_parameter
๐ Pro Tips:
Jump to labels. Use sparingly as it can make code hard to follow.
๐ ๐ H-Commands
HEX
Math
HEX - Convert Number to Hexadecimal
Converts binary or decimal input to an uppercase hexadecimal string.
USAGE:
HEX value
HEX target|value
INPUT SUPPORT:
Decimal: 42
Binary: 0b101010, 101010b
Hex passthrough: 0x2A, 2Ah, 2A
EXAMPLES:
HEX 42
HEX out|0b101010
HEX out|255
๐ Usage:
HEX value
๐ก Examples:
HEX 42
HEX out|0b101010
HEX out|255
๐ Pro Tips:
Check the documentation for advanced usage patterns
HLP
System
HLP - Dynamic Help System
Advanced help system that automatically categorizes functions based on their CATEGORY
attribute and provides comprehensive documentation.
USAGE:
HLP - Show all functions organized by categories
HLP FUNCTION - Show detailed help for a specific function
HLP CATEGORY - Show functions in a specific category
DYNAMIC CATEGORIES:
The help system automatically discovers categories from function modules.
Common categories: system, files, variables, flow, input, network, advanced
EXAMPLES:
HLP # Show categorized function overview
HLP BMK # Show detailed help for BMK function
HLP system # Show all system functions
HLP files # Show all file operation functions
The help system automatically discovers all function modules, reads their CATEGORY
attribute, and displays comprehensive documentation with usage examples.
๐ Usage:
HLP - Show all functions organized by categories
๐ก Examples:
HLP # Show categorized function overview
HLP BMK # Show detailed help for BMK function
HLP system # Show all system functions
HLP files # Show all file operation functions
๐ Pro Tips:
Interactive help system. Use "HLP categories" to browse by category.
๐ ๐ I-Commands
IFC
Control Flow & Logic
IFC - Conditional Execution
Runs commands only when a comparison is true. Use `::` for inline commands or
place the commands on following lines and close the block with END.
Usage:
IFC left|operator|right
IFC left|operator|right::then_command::ELSE::else_command::END
IFC left||right||then_command||ELSE||else_command
IFC left||operator||right||then_command||ELSE||else_command
Operators:
=, ==, !=, <>, >, >=, <, <=
Examples:
IFC %name%||||BRK
IFC %score%||>=||50||LOG Passed||ELSE||LOG Failed
IFC %role%|=|admin::LOG Welcome::ELSE::LOG Access denied::END
IFC %a%|=|1|AND|%b%|>|5::LOG Both conditions are true::END
IFC NOT|%enabled%|=|true::LOG Disabled::END
Notes:
In the `||` short form, `IFC left||right` means `left = right`.
`ELSE` and `ELS` are accepted. Omit the ELSE part when it is not needed.
๐ Usage:
IFC left|operator|right
๐ก Examples:
IFC %name%||||BRK
IFC %score%||>=||50||LOG Passed||ELSE||LOG Failed
IFC %role%|=|admin::LOG Welcome::ELSE::LOG Access denied::END
IFC %a%|=|1|AND|%b%|>|5::LOG Both conditions are true::END
IFC NOT|%enabled%|=|true::LOG Disabled::END
๐ Pro Tips:
Operators: ==, !=, >, <, >=, <=, contains. Use || as separator for conditions.
INP
Input & Output
INP - Input
Prompts the user for input and stores it in a variable.
Usage:
INP Variable|Prompt\n\nEXAMPLES:\n INP username|Enter your username\n INP age|How old are you?|number\n INP confirm|Continue? (y/n)|yesno\n INP password|Enter password|password\n
๐ Usage:
INP Variable|Prompt\n\nEXAMPLES:\n INP username|Enter your username\n INP age|How old are you?|number\n INP confirm|Continue? (y/n)|yesno\n INP password|Enter password|password\n
๐ก Examples:
\n INP username|Enter your username\n INP age|How old are you?|number\n INP confirm|Continue? (y/n)|yesno\n INP password|Enter password|password\n
๐ Pro Tips:
Input types: text (default), number, yesno, password. Supports default values.
๐ ๐ L-Commands
LBL
Control Flow & Logic
LBL - Label
Defines a subroutine (label) for use with SUB calls. Supports inline and block definitions.
Usage:
LBL labelname
LBL labelname::command1::command2::End (inline)
๐ Usage:
LBL labelname
๐ก Examples:
LBL example_parameter
๐ Pro Tips:
Define labels for GOT jumps. Use descriptive names for better readability.
LEN
Variables & Data Processing
LEN - Length
Stores the character count of a variable's current value.
Usage:
LEN source_variable|target_variable
Examples:
LEN username|username_len
LEN message|message_length
๐ Usage:
LEN source_variable|target_variable
๐ก Examples:
LEN username|username_len
LEN message|message_length
๐ Pro Tips:
Returns character count for strings, item count for lists/arrays.
LOA
Variables & Data Processing
LOA - Load Variables
Loads variables written by SAV. The file uses Python pickle format.
Usage:
LOA filename
LOA filename|variable1,variable2,...
Examples:
LOA session.sav
LOA session.sav|username,score
๐ Usage:
LOA filename
๐ก Examples:
LOA session.sav
LOA session.sav|username,score
๐ Pro Tips:
Loads entire file content into variable. Use for small to medium files only.
LOC
File & Directory Operations
LOC - Locate (Cursor)
Moves the cursor to the specified x,y coordinates in the terminal (Windows only).
Usage:
LOC x|y
x = column (1-based), y = row (1-based)
๐ Usage:
LOC x|y
๐ก Examples:
LOC example_parameter
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
LOG
Input
๐ LOG - Advanced Multi-Target Output System
Intelligent output routing system supporting simultaneous output to multiple targets
with advanced formatting, variable expansion, and cross-platform compatibility.
USAGE:
LOG message # Output to current Console target(s)
LOG Processing file: %filename% # Variable expansion in messages
LOG User %username% logged in at %time%
๐ฏ OUTPUT TARGETS (controlled by Console variable):
cmd - Console/terminal output with colors
gui - Graphical user interface (FluxionixGUI)
file - File logging (fluxionix.log)
web - Web interface output
๐ MULTI-TARGET OUTPUT:
SET Console cmd,gui,file # Output to multiple targets
SET Console cmd gui web # Space-separated targets
SET Console cmd|gui|file # Pipe-separated targets
โก ADVANCED FEATURES:
โข ๐จ Automatic color coding and formatting
โข ๐ Variable expansion with nested support
โข ๐ Real-time output to multiple targets simultaneously
โข ๐ Cross-platform compatibility (Windows/Linux/macOS)
โข ๐ฏ Intelligent newline handling
โข ๐ Automatic duplicate line filtering
โข ๐ Debug and verbose output modes
โข โฑ๏ธ Timestamp integration
โข ๐ Emoji and Unicode support
๐ FORMATTING FEATURES:
โข Automatic newline normalization
โข ANSI color preservation in terminals
โข HTML formatting for web output
โข Markdown support for documentation
โข Code block formatting with syntax highlighting
๐จ EXAMPLES:
LOG Starting application...
LOG Current user: %username%
LOG Processing %file_count% files
LOG โ
Operation completed successfully!
LOG โ ๏ธ Warning: Low disk space (%free_space% GB)
LOG โ Error: Connection failed to %server%
LOG ๐ Statistics: %processed%/%total% completed
LOG ๐ฏ Performance: %operations% ops/sec
๐ ADVANCED USE CASES:
Multi-target logging:
SET Console cmd,file,web
LOG ๐ System startup initiated
Conditional output:
IFC %debug_mode%||==||1||LOG ๐ Debug: Variable %var% = %value%
Performance monitoring:
LOG โฑ๏ธ Benchmark started at %start_time%
BMK quick
LOG โ
Benchmark completed in %duration% seconds
File processing pipeline:
FOR file|*.txt::LOG ๐ Processing %file%::NXT file
๐ก PRO TIPS:
โข Use emojis and symbols for visual categorization
โข Variable expansion supports nested variables: %user_%role%%
โข Multi-target output is atomic - all targets receive the same message
โข File output automatically creates fluxionix.log if it doesn't exist
โข Web output requires WEB function to be configured
โข GUI output requires FluxionixGUI to be running and connected
๐ฏ INTEGRATION WITH OTHER COMMANDS:
โข Works seamlessly with all variable types (SET, GET, CAL)
โข Supports output from command execution (GET results)
โข Integrates with conditional logic (IFC, WHI, FOR)
โข Compatible with background processes and threading
โข Supports real-time monitoring and live updates
๐ง TECHNICAL DETAILS:
โข UTF-8 encoding for international character support
โข Efficient memory usage for large output volumes
โข Thread-safe operation for concurrent access
โข Configurable output buffering and flushing
โข Error handling with graceful fallbacks
๐ Usage:
LOG message
๐ก Examples:
LOG Starting application...
LOG Current user: %username%
LOG Processing %file_count% files
LOG โ
Operation completed successfully!
LOG โ ๏ธ Warning: Low disk space (%free_space% GB)
๐ Pro Tips:
Supports variable substitution. Output goes to console and log files if configured.
๐ ๐ M-Commands
MAX
General
MAX - Maximum of Array
Gets the largest value from array-like entries (arr[1..n]) and stores it.
Usage:
MAX target|array
๐ Usage:
MAX target|array
๐ก Examples:
MAX example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
MEN
General
MEN - Menu (tkinter GUI)
Displays a graphical menu of options and returns the user's selection.
Usage:
MEN TITLE||OPTION1||COMMAND1||OPTION2||COMMAND2 ...
Arguments:
TITLE: Window title and prompt text (first argument).
OPTION||COMMAND: Button label and command to return, alternating pairs after the title.
Splitter usage:
Use '||' between menu items (title, options, commands).
Single '|' is allowed inside commands (e.g. SET A|1), but not between menu items.
Examples:
MEN Choose an option||Yes||LOG Yes||No||LOG No||Cancel||LOG Cancel
MEN Set value||Zero||SET A|0||One||SET A|1
Options are shown as buttons in a window. The selected command is returned.\n\nEXAMPLES:\n MEN choice|Select option|Option 1,Option 2,Option 3 # Display interactive menu with selectable options.\n MEN action|Choose action|Create,Edit,Delete,Exit\n MEN %variable%|%prompt%|%options% \n
๐ Usage:
MEN TITLE||OPTION1||COMMAND1||OPTION2||COMMAND2 ...
๐ก Examples:
MEN Choose an option||Yes||LOG Yes||No||LOG No||Cancel||LOG Cancel
MEN Set value||Zero||SET A|0||One||SET A|1
๐ Pro Tips:
Returns selected index starting from 1. Use comma-separated options.
MIN
General
MIN - Minimum of Array
Gets the smallest value from array-like entries (arr[1..n]) and stores it.
Usage:
MIN target|array
๐ Usage:
MIN target|array
๐ก Examples:
MIN example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ ๐ N-Commands
NXT
Control Flow & Logic
NXT - Next
Marks the end of a FOR loop body. It is consumed by the FOR parser and is not
executed as a standalone command.
Usage:
NXT variable
Examples:
FOR item|1|3
LOG Item %item%
NXT item
๐ Usage:
NXT variable
๐ก Examples:
NXT item
๐ Pro Tips:
Continue to next iteration in FOR/WHI loops. Like "continue" in other languages.
๐ ๐ O-Commands
ORD
String
ORD - Numeric Value from Character
Converts a single character to its numeric value.
For codepage-representable chars, CHR_CodePage mapping is used (default cp850).
USAGE:
ORD character
ORD target|character
EXAMPLES:
ORD ร
ORD code|ร
ORD code|%char%
LOG ord(ร)
๐ Usage:
ORD character
๐ก Examples:
ORD ร
ORD code|ร
ORD code|%char%
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ ๐ P-Commands
PFM
System & Performance
PFM - Performance Monitor
Monitors system performance, including CPU, memory, disk usage, and top processes.
Usage:
PFM [INFO|PROCESSES]
๐ Usage:
PFM [INFO|PROCESSES]
๐ก Examples:
PFM example_parameter
๐ Pro Tips:
Some commands may require administrator privileges
PLY
General
PLY - Play Alert Sound (๐)
Plays or stops a continuous warning/alert sound.
Useful for drawing attention or signaling important events.
Usage:
PLY ON # Start playing alert sound (loops)
PLY OFF # Stop the alert sound
Features:
โข Continuous looping sound until stopped
โข Non-blocking (script continues while playing)
โข Platform-specific sound implementation
โข Thread-safe start/stop
โข Automatic cleanup on exit
Sound Behavior:
Windows: Plays ascending beep tones (1000-5000 Hz)
Linux/Mac: System bell/alert sound
Examples:
Simple Alert:
LOG Starting critical process...
PLY ON # Start alert sound
# ... long running process ...
PLY OFF # Stop alert sound
LOG Process complete!
Error Notification:
IFC %error_count%|>|0
PLY ON
LOG WARNING: %error_count% errors detected!
SLP 5
PLY OFF
FIL
Timed Alert:
PLY ON
LOG System maintenance in progress...
SLP 10 # Alert for 10 seconds
PLY OFF
LOG Maintenance complete
Monitoring Loop:
FOR i|1|100
# Check some condition
IFC %status%|==|critical
PLY ON
LOG CRITICAL: System issue detected!
ANY # Wait for acknowledgment
PLY OFF
FIL
SLP 1
NXT
Practical Use Cases:
Long Process Notification:
LOG Starting backup...
# ... backup process ...
PLY ON
LOG Backup complete! Press any key.
ANY
PLY OFF
Multiple Alerts:
IFC %disk_full%|==|1
PLY ON
LOG ERROR: Disk is full!
SLP 3
PLY OFF
FIL
Notes:
โข Sound plays in background thread
โข Only one alert can play at a time
โข Starting when already playing has no effect
โข Stopping when not playing has no effect
โข Sound automatically stops when script ends
โข May require audio hardware/drivers
โข Volume controlled by system settings
๐ Usage:
PLY ON
๐ก Examples:
PLY ON # Start alert sound
PLY OFF # Stop alert sound
PLY ON
PLY OFF
PLY ON
๐ Pro Tips:
Supports audio/video files and streaming URLs. Use system default media player.
๐ ๐ Q-Commands
QUE
Input & Output
QUE - Question
Prompts the user for input and stores the answer in context.
Usage:
QUE [question]
EXAMPLES:
QUE name|What is your name?
QUE age|How old are you?
QUE confirm|Do you want to continue?
๐ Usage:
QUE [question]
๐ก Examples:
QUE name|What is your name?
QUE age|How old are you?
QUE confirm|Do you want to continue?
๐ Pro Tips:
Queue commands for background execution. Useful for long-running tasks.
QUT
Utilities & Helpers
QUT - Quit
Shows a message in a GUI dialog with an OK button, then exits the interpreter.
Usage:
QUT [message]
๐ Usage:
QUT [message]
๐ก Examples:
QUT example_parameter
๐ Pro Tips:
Emergency exit with immediate termination. Use for critical error handling.
๐ ๐ R-Commands
REF
File & Directory Operations
REF - Read File Line
Reads one 1-based line from a UTF-8 file into a variable. It can optionally
extract a character range and replace text in the extracted value.
Usage:
REF variable|file|line|[from]|[to]|[search]|[replace]
Examples:
REF line|User.txt|1
REF name|User.txt|1|1|12
REF cleaned|User.txt|2|1|100|old|new
Notes:
A missing file or line sets the target variable to an empty value.
๐ Usage:
REF variable|file|line|[from]|[to]|[search]|[replace]
๐ก Examples:
REF line|User.txt|1
REF name|User.txt|1|1|12
REF cleaned|User.txt|2|1|100|old|new
๐ Pro Tips:
Quick reference for commands. Use specific command name for detailed help.
REM
Utilities & Helpers
REM - Remark
A comment line. No action is performed. Used for documentation in scripts.
Usage:
REM [comment]
EXAMPLES:
REM This is a comment
REM === Configuration Section ===
REM TODO: Add error handling
๐ Usage:
REM [comment]
๐ก Examples:
REM This is a comment
REM === Configuration Section ===
REM TODO: Add error handling
๐ Pro Tips:
Check the documentation for advanced usage patterns
REQ
Development & Testing
REQ - Version Requirement
Checks if the current interpreter version is greater than or equal to the required version. Exits if not met.
Usage:
REQ Version
๐ Usage:
REQ Version
๐ก Examples:
REQ example_parameter
๐ Pro Tips:
Enable debug mode for detailed execution information
RJS
Data Formats & Apis
RJS - Read JSON
Reads a JSON file, extracts data using a path, and stores the result in a variable. Supports nested objects and arrays.
Usage:
RJS file|path|variable|[default]
๐ Usage:
RJS file|path|variable|[default]
๐ก Examples:
RJS example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
RND
Variables & Data Processing
RND - Random Number Generator (๐ฒ)
Generates a random integer between specified minimum and maximum values (inclusive)
and stores the result in a variable.
Usage:
RND variable|min|max
Parameters:
variable - Variable name to store the random number
min - Minimum value (inclusive)
max - Maximum value (inclusive)
Features:
โข Cryptographically random (uses system random)
โข Inclusive range (both min and max can be generated)
โข Integer values only
โข Immediate variable assignment
Examples:
Dice Roll (1-6):
RND dice|1|6
LOG You rolled: %dice%
Coin Flip (0=Tails, 1=Heads):
RND coin|0|1
IFC %coin%|==|1
LOG Heads!
FIL
IFC %coin%|==|0
LOG Tails!
FIL
Lottery Number (1-49):
RND lotto1|1|49
RND lotto2|1|49
RND lotto3|1|49
LOG Your numbers: %lotto1%, %lotto2%, %lotto3%
Random Percentage (0-100):
RND chance|0|100
IFC %chance%|>|75
LOG Success! (>75%)
FIL
Random Delay (100-500ms):
RND delay|100|500
LOG Waiting %delay%ms...
SLP %delay%
Practical Applications:
Random Testing:
FOR i|1|10
RND test_value|1|100
LOG Test #%i%: %test_value%
NXT
Randomized Selection:
RND choice|1|3
IFC %choice%|==|1
LOG Selected Option A
FIL
IFC %choice%|==|2
LOG Selected Option B
FIL
IFC %choice%|==|3
LOG Selected Option C
FIL
Random Color (RGB):
RND red|0|255
RND green|0|255
RND blue|0|255
LOG Color: RGB(%red%, %green%, %blue%)
Simulation:
RND temperature|-10|35
RND humidity|20|90
LOG Weather: %temperature%ยฐC, %humidity%% humidity
Notes:
โข Both min and max are inclusive in the range
โข Min can be negative: RND temp|-20|40
โข Max must be >= Min
โข Result is always an integer
โข Each call produces a new random value
โข Uses high-quality random number generator
โข Variable is stored as string (use in comparisons/calculations)
๐ Usage:
RND variable|min|max
๐ก Examples:
RND dice|1|6
RND coin|0|1
RND lotto1|1|49
RND lotto2|1|49
RND lotto3|1|49
๐ Pro Tips:
Generates random integers. Use for dice, lottery numbers, or random selections.
RSF
File & Directory Operations
RSF - Replace String in File (๐)
Replaces a substring in a file with another string. Search is case-insensitive by default.
Usage:
RSF FileName|SearchText|ReplaceText[|case]
Options:
case - Add 'case' as 4th parameter for case-sensitive search
Examples:
RSF test.txt|hello|goodbye - Case-insensitive: replaces Hello, HELLO, hello
RSF test.txt|hello|goodbye|case - Case-sensitive: replaces only hello
๐ Usage:
RSF FileName|SearchText|ReplaceText[|case]
๐ก Examples:
RSF test.txt|hello|goodbye - Case-insensitive: replaces Hello, HELLO, hello
RSF test.txt|hello|goodbye|case - Case-sensitive: replaces only hello
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
RSV
Variables & Data Processing
RSV - Replace String in Variable (โ๏ธ)
Searches for a substring in a variable's value and replaces all occurrences with another string.
Search is case-insensitive by default, with optional case-sensitive mode.
Usage:
RSV variable|search|replace[|case]
Parameters:
variable - Name of variable to modify
search - Text to find (case-insensitive by default)
replace - Text to replace with
case - (Optional) Add 'case' for case-sensitive search
Features:
โข Case-insensitive search by default
โข Replaces ALL occurrences
โข Modifies variable in-place
โข Optional case-sensitive mode
โข Reports number of replacements
Examples:
Basic Replacement (case-insensitive):
SET greeting|Hello World, hello there
RSV greeting|hello|hi
LOG %greeting% # "hi World, hi there"
Case-Sensitive Mode:
SET text|Hello hello HELLO
RSV text|hello|hi|case
LOG %text% # "Hello hi HELLO" (only lowercase)
Remove Text:
SET path|C:\\Users\\Documents
RSV path|C:\\Users\\|
LOG %path% # "Documents"
Clean Whitespace:
SET data|value1 , value2 , value3
RSV data| |
LOG %data% # "value1,value2,value3"
Replace Special Characters:
SET filename|My File (copy).txt
RSV filename|(|_
RSV filename|)|_
RSV filename| |_
LOG %filename% # "My_File__copy_.txt"
Practical Applications:
Path Conversion:
SET path|C:\\Projects\\MyApp
RSV path|\\|/
LOG Unix path: %path% # "C:/Projects/MyApp"
Data Cleaning:
SET csv|name,age,city
RSV csv|,|;
LOG %csv% # "name;age;city"
Template Processing:
SET template|Dear {{NAME}}, welcome to {{COMPANY}}
RSV template|{{NAME}}|John
RSV template|{{COMPANY}}|TechCorp
LOG %template%
Normalize Input:
INP username|Enter username
RSV username| |
RSV username|-|_
LOG Normalized: %username%
Multiple Replacements:
SET url|https://example.com/path/to/file
RSV url|https://|http://
RSV url|example.com|newdomain.com
LOG %url% # "http://newdomain.com/path/to/file"
Notes:
โข Replaces ALL occurrences in the variable
โข Case-insensitive by default (use |case for case-sensitive)
โข Variable must exist or error is logged
โข Empty search string is not allowed
โข Empty replace string removes the search text
โข Original variable value is overwritten
โข For file content replacement, use RSF command instead
๐ Usage:
RSV variable|search|replace[|case]
๐ก Examples:
RSV greeting|hello|hi
RSV text|hello|hi|case
RSV path|C:\\Users\\|
RSV data| |
RSV filename|(|_
๐ Pro Tips:
Reserve variables before loops to restore original values later.
RXM
Data Formats & Apis
RXM - Read XML (๐)
Reads an XML file, extracts data using XPath expressions, and stores the result in a variable.
Supports element text content and attributes. Multiple matches are stored as JSON array.
Usage:
RXM file|xpath|variable|[attribute]
Parameters:
file - Path to the XML file
xpath - XPath expression to locate elements
variable - Variable name to store the result
attribute - (Optional) Attribute name to extract instead of text content
XPath Features:
- Basic paths: tag/subtag/element
- Wildcards: */element or tag/*
- Conditions: element[@attribute='value'] or element[@attribute]
- Root paths: /root/element or root/element
Stored Variables:
{variable} - The extracted value(s) (string or JSON array)
{variable}_count - Number of elements found
Examples:
Example XML (config.xml):
admin
secret
Basic element text:
RXM config.xml|database/user|db_user
โ Stores "admin" in db_user
Extract attribute:
RXM config.xml|database|db_host|host
โ Stores "localhost" in db_host
Multiple elements:
RXM config.xml|servers/server|server_list|name
โ Stores ["web1", "web2"] as JSON in server_list
โ Sets server_list_count = "2"
With condition:
RXM config.xml|servers/server[@name='web1']|web1_server|ip
โ Stores "192.168.1.10" in web1_server
Wildcard:
RXM config.xml|*/user|username
โ Finds user element anywhere under root
Notes:
- Single match: Stores value as string
- Multiple matches: Stores as JSON array
- No match: Stores empty string ""
- Always sets {variable}_count
- Supports variable substitution in file, xpath, and attribute parameters
๐ Usage:
RXM file|xpath|variable|[attribute]
๐ก Examples:
RXM example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ ๐ S-Commands
SAV
Variables & Data Processing
SAV - Save Variables
Writes selected variables, or all public context values, to a Python pickle file.
Usage:
SAV filename
SAV filename|variable1,variable2,...
Examples:
SAV session.sav
SAV session.sav|username,score,level
๐ Usage:
SAV filename
๐ก Examples:
SAV session.sav
SAV session.sav|username,score,level
๐ Pro Tips:
Automatically creates directory structure. Supports variable substitution in content.
SCH
System & Performance
SCH - Scheduler (โฐ)
With SCH you can schedule any interpreter command to run at a specific time.
You can add, remove, list, start, stop tasks and check the scheduler status.
Usage:
SCH ADD|name|time|command|[repeat]
SCH REMOVE|name
SCH LIST
SCH START
SCH STOP
SCH STATUS
Parameters:
name - Name of the task (freely chosen, must be unique)
time - Time (e.g. 23:00, 2025-07-25 18:00, +5m, +30s)
command - Interpreter command to execute (as in the console)
repeat -
For absolute times: ONCE (default), DAILY, HOURLY, WEEKLY
For relative times (+5m, +30s, +2h): ONCE (default), CONTINUOUSLY
Examples:
SCH ADD|backup|23:00|SAV ALL|DAILY
โ Executes SAV ALL every day at 23:00
SCH ADD|cleanup|+5m|FIL DEL|ONCE
โ Executes FIL DEL in 5 minutes
SCH ADD|mytask|+5m|FIL DEL|CONTINUOUSLY
โ Executes FIL DEL every 5 minutes, starting in 5 minutes
SCH REMOVE|backup
โ Removes the task 'backup'
SCH LIST
โ Shows all scheduled tasks
Note:
Scheduled tasks are saved automatically and reloaded on next start.
๐ Usage:
SCH ADD|name|time|command|[repeat]
๐ก Examples:
SCH ADD|backup|23:00|SAV ALL|DAILY
SCH ADD|cleanup|+5m|FIL DEL|ONCE
SCH ADD|mytask|+5m|FIL DEL|CONTINUOUSLY
SCH REMOVE|backup
SCH LIST
๐ Pro Tips:
Some commands may require administrator privileges
SEA
File & Directory Operations
SEA - Search File or Folder
Searches recursively for an exact file or folder name. A single match is stored;
when several matches exist, SEA asks which one to use.
Usage:
SEA variable|exact_name|location
Examples:
SEA config_path|settings.ini|C:\Config
SEA script_path|run.py|C:\Scripts
๐ Usage:
SEA variable|exact_name|location
๐ก Examples:
SEA config_path|settings.ini|C:\Config
SEA script_path|run.py|C:\Scripts
๐ Pro Tips:
Searches files and content. Supports regex patterns and multiple search locations.
SET
Variables
SET - Variable Assignment System
Intelligent variable assignment with automatic type detection, validation,
and support for complex data structures.
USAGE:
SET variable|value # Basic assignment
SET a[1]|foo # 1D array-like key assignment
SET a[x]|foo # Index variable resolution (if x exists)
SET matrix[x][y][z]|42 # Multi-dimensional array-like keys
SET variable value # Space-separated assignment
SET variable|%other_variable% # Variable reference assignment
SET variable|json:{"key":"value"} # JSON object assignment
SET variable|list:[1,2,3] # List assignment
SET variable|int:42 # Type-specific assignment
SET variable|float:3.14 # Float assignment
SET variable|bool:true # Boolean assignment
๐ฏ TYPE CASTING:
int:value - Convert to integer
float:value - Convert to floating point
bool:value - Convert to boolean (true/false, 1/0, yes/no)
str:value - Explicit string conversion
json:value - Parse as JSON object
list:value - Parse as list/array
auto:value - Automatic type detection
โก ADVANCED FEATURES:
โข ๐ Automatic type detection and conversion
โข ๐ Variable validation and error checking
โข ๐ Reference chaining (%var1% โ %var2% โ value)
โข ๐ JSON and list parsing with validation
โข ๐ฏ Math expression evaluation (SET result|calc:5+3*2)
โข ๐ Environment variable integration
โข ๐พ Persistent variable storage options
๐ EXAMPLES:
SET username|JohnDoe # Simple string
SET a[1]|1 # Array-like key
SET a[2]|2
FOR x|1|2::LOG %a[x]%::NXT x # Outputs 1 then 2
SET grid[1][2][3]|hello # Multi-dimensional access via %grid[i][j][k]%
SET age|int:25 # Integer with validation
SET config|json:{"debug":true} # JSON object
SET items|list:[apple,banana,cherry] # List of items
SET result|calc:10*5+2 # Math expression
SET flag|bool:yes # Boolean from yes/no
SET current_user|%USERNAME% # Environment variable
SET backup_user|%current_user% # Variable reference
๐ก PRO TIPS:
โข Variables are case-sensitive and persistent across sessions
โข Use descriptive names: user_count instead of uc
โข JSON objects support nested structures and arrays
โข Math expressions support +, -, *, /, %, ** (power), ()
โข Boolean values: true/false, yes/no, 1/0, on/off
โข Variable references support nested expansion: %outer_%inner%%
๐ง COMPATIBILITY:
โ
Enhanced type system with validation
โ
Cross-platform variable persistence
โ
Integration with all Fluxionix commands
๐ Usage:
SET variable|value
๐ก Examples:
SET username|JohnDoe # Simple string
SET a[1]|1 # Array-like key
SET a[2]|2
SET grid[1][2][3]|hello # Multi-dimensional access via %grid[i][j][k]%
SET age|int:25 # Integer with validation
๐ Pro Tips:
Use the pipe | separator. Variables support nested references.
SLP
Multimedia & Sound
SLP - Sleep/Pause (โธ๏ธ)
Pauses script execution for a specified duration in seconds.
Supports fractional seconds for precise timing.
Usage:
SLP seconds
Parameters:
seconds - Duration to pause (supports decimals)
Features:
โข Precise timing with fractional seconds
โข Variable substitution support
โข Non-blocking (script resumes after duration)
โข Useful for delays, throttling, and timing
Examples:
Basic Delays:
SLP 1 # Pause for 1 second
SLP 5 # Pause for 5 seconds
SLP 0.5 # Pause for 500 milliseconds
SLP 0.1 # Pause for 100 milliseconds
With Variables:
SET delay|2.5
SLP %delay% # Pause for 2.5 seconds
Rate Limiting:
FOR i|1|10
LOG Processing item %i%
# ... do work ...
SLP 0.5 # Wait 500ms between items
NXT
Countdown:
SET count|5
FOR i|5|1|-1
LOG Countdown: %i%
SLP 1
NXT
LOG Go!
Progressive Delays:
SET delay|0.1
FOR i|1|5
LOG Step %i%
SLP %delay%
SET delay|%delay%*2 # Double the delay each time
NXT
Practical Applications:
Polling Loop:
FOR i|1|60
# Check status
IFC %status%|==|ready
LOG Status is ready!
BRK
FIL
LOG Waiting... (%i%/60)
SLP 1 # Check every second
NXT
Throttled API Calls:
FOR file IN %file_list%
LOG Uploading %file%
# ... upload file ...
SLP 0.5 # Avoid rate limiting
NXT
User Interface Timing:
LOG Welcome to the system!
SLP 2
CLS
LOG Loading modules...
SLP 1
LOG Ready!
Retry with Backoff:
SET retry|0
LBL retry_start
# ... attempt operation ...
IFC %success%|!=|1
SET retry|%retry%+1
IFC %retry%|<|5
LOG Retry attempt %retry%
SLP %retry% # Wait 1s, 2s, 3s, 4s
GOT retry_start
FIL
FIL
Timing Examples:
SLP 0.001 # 1 millisecond
SLP 0.01 # 10 milliseconds
SLP 0.1 # 100 milliseconds
SLP 1 # 1 second
SLP 60 # 1 minute
SLP 3600 # 1 hour
Notes:
โข Accepts decimal values for sub-second precision
โข Minimum effective resolution depends on OS (usually 1-10ms)
โข Script is blocked during sleep (other tasks won't run)
โข For very long delays, consider using scheduler
โข Interrupted by Ctrl+C
โข Default is 1 second if no argument provided
๐ Usage:
SLP seconds
๐ก Examples:
SLP 1 # Pause for 1 second
SLP 5 # Pause for 5 seconds
SLP 0.5 # Pause for 500 milliseconds
SLP 0.1 # Pause for 100 milliseconds
SLP %delay% # Pause for 2.5 seconds
๐ Pro Tips:
Sleep time in milliseconds. Use for delays, rate limiting, or waiting for processes.
SND
Network & Communication
SND - Send Email
Sends an email using SMTP with configuration from context. Supports attachments.
Usage:
SND variable|recipient|subject|message|[attachment]
EXAMPLES:
SND result|user@example.com|Test|Hello World
SND status|admin@company.com|Report|Daily backup completed
SND error|support@company.com|Error|System failure|error.log
๐ Usage:
SND variable|recipient|subject|message|[attachment]
๐ก Examples:
SND result|user@example.com|Test|Hello World
SND status|admin@company.com|Report|Daily backup completed
SND error|support@company.com|Error|System failure|error.log
๐ Pro Tips:
Check internet connectivity before running network commands
SPL
Variables & Data Processing
SPL - Split String (๐ช)
Splits a variable's string value by a delimiter and extracts a specific part
by index, storing the result back in the same variable. It can also assign all
parts to multiple variables in one line.
Usage:
SPL variable|delimiter|index
SPL var1,var2,var3|sourcevar|delimiter
Parameters:
variable - Variable name to split and update
delimiter - Character(s) to split on
index - Zero-based index of part to keep
var1,... - Destination variables for all split parts
sourcevar - Variable containing the string to split
Features:
โข Zero-based indexing (0 = first part)
โข Modifies variable in-place
โข Any delimiter length supported
โข Automatic error handling
โข Empty result if index out of range
Examples:
Extract from CSV:
SET data|John,Doe,30,Engineer
SPL data|,|0
LOG First name: %data% # "John"
Assign all CSV fields:
SET source|Hallo,mein,Name
SPL var1,var2,var3|source|,
LOG %var1% %var2% %var3% # "Hallo mein Name"
SET data|John,Doe,30,Engineer
SPL data|,|3
LOG Profession: %data% # "Engineer"
Parse File Path:
SET path|C:\\Users\\John\\Documents\\file.txt
SPL path|\\|-1 # Get last part
LOG Filename: %path% # "file.txt"
Extract Email Domain:
SET email|user@example.com
SPL email|@|1
LOG Domain: %email% # "example.com"
Parse URL:
SET url|https://www.example.com/path/to/page
SPL url|/|2
LOG Hostname: %url% # "www.example.com"
Extract First Word:
SET sentence|Hello World from Fluxionix
SPL sentence| |0
LOG First word: %sentence% # "Hello"
Practical Applications:
Process CSV Line:
SET csv_line|Name,Age,City,Country
SET field|%csv_line%
SPL field|,|2
LOG City: %field% # "City"
Parse Version Number:
SET version|2.5.1
SET major|%version%
SPL major|.|0
LOG Major version: %major% # "2"
SET minor|%version%
SPL minor|.|1
LOG Minor version: %minor% # "5"
Extract File Extension:
SET filename|document.backup.txt
SPL filename|.|-1 # Last part
LOG Extension: %filename% # "txt"
Parse Log Entry:
SET log|2024-01-15 14:30:45 ERROR Database connection failed
SET time|%log%
SPL time| |1
LOG Time: %time% # "14:30:45"
SET level|%log%
SPL level| |2
LOG Level: %level% # "ERROR"
Multiple Splits:
SET data|user:password:role:department
SET username|%data%
SPL username|:|0
LOG User: %username% # "user"
SET role|%data%
SPL role|:|2
LOG Role: %role% # "role"
Error Handling:
SET value|a,b,c
SPL value|,|5 # Index out of range
LOG %value% # "" (empty)
Notes:
โข Index starts at 0 (first element)
โข Negative indices not supported (use positive from start)
โข Out of range index sets variable to empty string
โข Original variable value is overwritten
โข Delimiter can be multiple characters: SPL data|:::|1
โข Empty delimiter not supported
โข For keeping all parts, consider alternative approaches
โข Variable must exist or error is logged
๐ Usage:
SPL variable|delimiter|index
๐ก Examples:
SPL data|,|0
๐ Pro Tips:
Variable names are case-sensitive and support context inheritance
SQI
General
SQI - SQL Instances
Checks for Microsoft SQL Server instances on Windows. Compatible with OldAchoo SQLInstances.
Usage:
SQI Variable|Version
๐ Usage:
SQI Variable|Version
๐ก Examples:
SQI example_parameter
๐ Pro Tips:
Execute SQL queries on SQLite databases. Supports SELECT, INSERT, UPDATE, DELETE.
SQV
Database
SQV - SQL Server Version Year
Extracts the SQL Server version year (e.g., 2019, 2022) from the connected server.
Usage:
SQV variable_name # Store version year in variable
SQV # Display version year only
Examples:
SQV sql_year # Stores "2019" in sql_year
SQV # Displays: SQL Server version: 2019
Context Variables Used:
SQLCOM/SQLCOMM/SQLIP - SQL Server instance
SQLDB - Database name
SQLUSER/SQLPASS - SQL Server credentials
Version Detection:
SQL Server 2022 โ 2022
SQL Server 2019 โ 2019
SQL Server 2017 โ 2017
SQL Server 2016 โ 2016
SQL Server 2014 โ 2014
SQL Server 2012 โ 2012
SQL Server 2008 โ 2008
๐ Usage:
SQV variable_name
๐ก Examples:
SQV sql_year # Stores "2019" in sql_year
SQV # Displays: SQL Server version: 2019
๐ Pro Tips:
Check the documentation for advanced usage patterns
SRT
General
SRT - Sort Array
Sorts Fluxionix array-like entries such as arr[1], arr[2], ... using arr[0] as count.
Usage:
SRT array
SRT array|asc
SRT array|desc
SRT array|asc|target_array
Notes:
- If target_array is omitted, sorting happens in-place.
- Sorting is numeric when all values are numbers; otherwise string sort is used.
๐ Usage:
SRT array
๐ก Examples:
SRT example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
SSH
General
SSH - Secure Shell Remote Access
Advanced SSH client for secure remote command execution, file transfer,
and system administration over encrypted connections.
USAGE:
SSH host|user|password|command # Execute remote command
SSH host|user|password|UPLOAD|local|remote # Upload file via SFTP
SSH host|user|password|DOWNLOAD|remote|local # Download file via SFTP
SSH host|user|password|SHELL # Interactive SSH shell session
๐ฏ ADVANCED FEATURES:
โข ๐ Secure remote command execution
โข ๐ SFTP file transfer (upload/download)
โข ๐ฅ๏ธ Interactive shell sessions
โข ๐ Password and key-based authentication
โข โฑ๏ธ Configurable connection timeout
โข ๐ก๏ธ Host key verification and management
โข ๐ Connection status monitoring
โข ๐ Error handling and retry logic
โ๏ธ CONNECTION OPTIONS:
host - Remote server IP/hostname
user - SSH username
password - SSH password (or key file path)
port - SSH port (default: 22)
timeout - Connection timeout in seconds
๐ EXAMPLES:
SSH 192.168.1.100|admin|secret|ls -la
SSH server.com|user|pass|UPLOAD|file.txt|/tmp/file.txt
SSH 10.0.0.1|root|key.pem|DOWNLOAD|/var/log/app.log|./app.log
SSH myserver|user|password|SHELL
๐ง SECURITY NOTES:
โข Always use strong passwords or SSH keys
โข Verify host fingerprints on first connection
โข Use non-standard ports when possible
โข Enable key-based authentication for production
๐ Usage:
SSH host|user|password|command
๐ก Examples:
SSH 192.168.1.100|admin|secret|ls -la
SSH server.com|user|pass|UPLOAD|file.txt|/tmp/file.txt
SSH 10.0.0.1|root|key.pem|DOWNLOAD|/var/log/app.log|./app.log
SSH myserver|user|password|SHELL
๐ Pro Tips:
Use "interactive" mode for shell access. Supports key-based authentication.
SST
System & Performance
SST - Service Status
Checks the status of a Windows service and stores the result in a variable.
Usage:
SST variable|service_name
๐ Usage:
SST variable|service_name
๐ก Examples:
SST example_parameter
๐ Pro Tips:
Some commands may require administrator privileges
STP
General
STP - Setup
Opens the setup configuration menu for Fluxionix with explicit save confirmation.
Usage:
STP # Open interactive setup menu
STP EMAIL # Quick email setup wizard
Notes:
- Type CANCEL at any prompt to abort without saving changes.
- WEB output mode is deprecated and no longer offered in setup.
๐ Usage:
STP
๐ก Examples:
STP example_parameter
๐ Pro Tips:
Use process name or PID. Be careful with system processes!
STR
General
STR - Variable Stripping
Strips characters from a variable and updates it, routing all output via LOG.py.
Usage:
STR var|l|N # Removes N characters from the left of variable 'var'
STR var|r|N # Removes N characters from the right of variable 'var'
Examples:
STR myvar|l|3 # Updates 'myvar' by removing 3 characters from the left
STR myvar|r|2 # Updates 'myvar' by removing 2 characters from the right\n\nEXAMPLES:\n STR result|Hello World|upper\n STR filename|document.txt|replace|txt|pdf\n STR text| spaces |strip\n STR words|Hello World|split| \n
๐ Usage:
STR var|l|N
๐ก Examples:
STR myvar|l|3 # Updates 'myvar' by removing 3 characters from the left
STR myvar|r|2 # Updates 'myvar' by removing 2 characters from the right\n\nEXAMPLES:\n STR result|Hello World|upper\n STR filename|document.txt|replace|txt|pdf\n STR text| spaces |strip\n STR words|Hello World|split| \n
๐ Pro Tips:
Available operations: upper, lower, strip, replace, split, join, length.
SUB
Control Flow & Logic
SUB - Subroutine Call
Calls a subroutine by name, with call depth protection and optional authentication for subroutine files.
Usage:
SUB subroutine_name\n\nEXAMPLES:\n SUB my_script.sub # Execute Fluxionix subscripts (.sub files) with relative/absolute paths.\n SUB automation\task.sub \n SUB %script_path% \n SUB subscripts\backup.sub \n
๐ Usage:
SUB subroutine_name\n\nEXAMPLES:\n SUB my_script.sub
๐ก Examples:
\n SUB my_script.sub # Execute Fluxionix subscripts (.sub files) with relative/absolute paths.\n SUB automation\task.sub \n SUB %script_path% \n SUB subscripts\backup.sub \n
๐ Pro Tips:
Execute Fluxionix subscripts. Supports relative and absolute paths.
๐ ๐ T-Commands
THR
Development & Testing
THR - Thread
Simple thread management for parallel execution. Supports starting a thread with a command and listing active threads.
Usage:
THR START|name|command # Start a new thread named 'name' running 'command'
THR LIST # List all active threads
Examples:
THR START|MyThread|SUB MYSUB
THR LIST
๐ Usage:
THR START|name|command
๐ก Examples:
THR START|MyThread|SUB MYSUB
THR LIST
๐ Pro Tips:
Enable debug mode for detailed execution information
TIM
Utilities & Helpers
TIM - Time
Gets the current time in a specified format and stores it in a variable.
USAGE:
TIM Variable|[Format]
DEFAULT FORMAT:
%H:%M:%S
EXAMPLES:
TIM current_time|%H:%M:%S # current_time = "15:30:45"
TIM hour|%H # hour = "15"
TIM minute|%M # minute = "30"
TIM full_timestamp|%Y-%m-%d_%H-%M-%S # full_timestamp = "2025-08-16_15-30-45"
๐ Usage:
TIM Variable|[Format]
๐ก Examples:
TIM current_time|%H:%M:%S # current_time = "15:30:45"
TIM hour|%H # hour = "15"
TIM minute|%M # minute = "30"
TIM full_timestamp|%Y-%m-%d_%H-%M-%S # full_timestamp = "2025-08-16_15-30-45"
๐ Pro Tips:
Same format codes as DAT. Useful for timestamps and time-based logic.
TIT
Input & Output
TIT - Title
Sets the window title (Windows only).
Usage:
TIT Title
๐ Usage:
TIT Title
๐ก Examples:
TIT example_parameter
๐ Pro Tips:
Sets console window title. Useful for progress indication in long-running scripts.
TMR
System & Performance
TMR - Timer
Performs timer operations such as start, stop, elapsed, wait, schedule, and list. Duration can be in seconds or formatted (e.g., 1h30m45s).
Usage:
TMR action|[name]|[duration]|[command]
Actions: START, STOP, ELAPSED, WAIT, SCHEDULE, LIST
EXAMPLES:
TMR start|backup_timer
TMR wait|5
TMR schedule|reminder|1h30m|MSG Lunch break!
TMR stop|backup_timer
TMR list
๐ Usage:
TMR action|[name]|[duration]|[command]
๐ก Examples:
TMR start|backup_timer
TMR wait|5
TMR schedule|reminder|1h30m|MSG Lunch break!
TMR stop|backup_timer
TMR list
๐ Pro Tips:
Timer names are case-sensitive. Use descriptive names for multiple timers.
TOD
Productivity
TOD - ToDo Task Management
Advanced task management system with priorities, categories, due dates, and persistence.
Integrated with GUI for seamless task tracking and productivity management.
USAGE:
TOD # Show all tasks
TOD list # Show all tasks (detailed view)
TOD add||[description] # Add new task with optional description
TOD remove| # Remove task by name
TOD done| # Mark task as completed
TOD edit||done # Mark task as done
TOD edit||description| # Edit task description
TOD priority||<1-5> # Change task priority
TOD category|| # Change task category
TOD search| # Search tasks by keyword
TOD export|[filename] # Export tasks to file
TOD import|[filename] # Import tasks from file
TOD stats # Show productivity statistics
TOD clear # Clear all completed tasks
TOD purge # Clear all tasks (with confirmation)
PRIORITY LEVELS:
1 - ๐ด URGENT (Critical, immediate action required)
2 - ๐ HIGH (Important, high priority)
3 - ๐ก MEDIUM (Normal priority, default)
4 - ๐ข LOW (Low priority, when time permits)
5 - ๐ต SOMEDAY (Future consideration)
CATEGORIES:
work, personal, home, project, meeting, call, email, shopping, health, learning
FEATURES:
๐ท๏ธ Task categorization and tagging
๐
Due date tracking and reminders
โญ Priority-based task sorting
๐ Productivity statistics and analytics
๐พ Persistent storage across sessions
๐ Advanced search and filtering
๐ค Export/import functionality
โ
Completion tracking and history
๐ฏ Goal setting and progress tracking
๐ Notification system (GUI integration)
EXAMPLES:
TOD add|"Review quarterly reports"
TOD add|"Call client"|"About the new project timeline"
TOD add|"Buy groceries"|"Milk, bread, eggs"
TOD done|"Review quarterly reports"
TOD priority|"Call client"|2
TOD category|"Buy groceries"|personal
TOD edit|"Call client"|done
TOD edit|"Call client"|description|"Call client urgently"
TOD remove|"Buy groceries"
TOD search|project
TOD stats
TOD export|my_tasks.json
INTEGRATION:
โข Seamless GUI integration with real-time updates
โข Calendar integration for due date management
โข Email notifications for urgent tasks
โข Progress tracking and productivity analytics
โข Team collaboration features (future enhancement)
๐ Usage:
TOD
๐ก Examples:
TOD add|"Review quarterly reports"
TOD add|"Call client"|"About the new project timeline"
TOD add|"Buy groceries"|"Milk, bread, eggs"
TOD done|"Review quarterly reports"
TOD priority|"Call client"|2
๐ Pro Tips:
Check the documentation for advanced usage patterns
TON
System & Performance
TON - Task / Process Check
On Windows, lists running processes or stores whether a named process is
running. Process matching is case-insensitive and ignores a trailing `.exe`.
Usage:
TON
TON variable|process_name
Examples:
TON # Print the running process list
TON browser_running|chrome # Set %browser_running% to true or false
IFC %browser_running%|=|true::LOG Browser is running::END
๐ Usage:
TON
๐ก Examples:
TON # Print the running process list
TON browser_running|chrome # Set %browser_running% to true or false
๐ Pro Tips:
Some commands may require administrator privileges
๐ ๐ V-Commands
VER
Development & Testing
VER - Version
Outputs the interpreter version via LOG.py or stores it in a variable. Also sets the window title on Windows.
Usage:
VER [var]\n\nEXAMPLES:\n VER # Display version information for Fluxionix, Python, and system components.\n VER system \n VER python \n VER fluxionix \n
๐ Usage:
VER [var]\n\nEXAMPLES:\n VER
๐ก Examples:
\n VER # Display version information for Fluxionix, Python, and system components.\n VER system \n VER python \n VER fluxionix \n
๐ Pro Tips:
Shows version information for Fluxionix, Python, and system components.
๐ ๐ W-Commands
WHI
Control Flow & Logic
WHI - While Loop
Creates a WHILE loop with condition checking. Supports operators <, >, <=, >=, ==, != and safety features.
Usage:
WHI %Variable%|Operator|Value
... commands ...
WND
Operators:
<, >, <=, >=, ==, !=
Logical Operators:
AND, OR, NOT
Control Commands:
BRK - Break out of the loop (exit loop immediately)
CNT - Continue to next iteration (skip remaining commands)
Examples:
WHI %counter%|<|10
LOG Counter is %counter%
CAL counter|+|1
WND
WHI %x%|>=|1|AND|%y%|<|20
LOG Both conditions true
CAL x|-|1
WND
WHI %status%|==|active|OR|%force%|==|true
LOG Processing...
SLP 1000
WND
WHI %running%|==|true
INP user_input|Enter command (exit to quit):
IFC %user_input%|==|exit::BRK::END
IFC %user_input%|==|skip::CNT::END
LOG Processing: %user_input%
WND
Safety Features:
โข Maximum iteration limit (default: 100)
โข Infinite loop detection\n\nEXAMPLES:\n WHI %counter%|<|100::CAL counter|%counter%|+|1::LOG Counter: %counter% # While loop with condition checking and command execution.\n WHI %running%|==|true::LOG Still running...::SLP 1000\n WHI %condition%|!=|exit::LOG Processing...::NXT\n
๐ Usage:
WHI %Variable%|Operator|Value
๐ก Examples:
WHI %counter%|<|10
๐ Pro Tips:
Always include a way to break the loop to avoid infinite loops.
WIN
Gui
WIN - Basic GUI Builder (Tkinter)
Creates simple GUI windows and controls that integrate with Fluxionix variables.
SEPARATORS:
Preferred: || (recommended for commands/text with |)
Legacy: |
USAGE:
WIN create||name||width||height||x||y
WIN label||name||width||height||x||y||text
WIN entry||name||width||height||x||y||default_text||variable
WIN button||name||width||height||x||y||command
WIN button||name||width||height||x||y||text=caption||command
WIN checkbox||name||width||height||x||y||text||variable||checked
WIN radiobutton||name||width||height||x||y||text||variable||value||selected
WIN get||name
WIN show||name
WIN close||name
NOTES:
โข `WIN get` writes entry/check/radio values into their mapped Fluxionix variables.
โข `WIN button` executes Fluxionix command(s). Use :: for multiple commands.
โข For command/text payloads that contain |, use || as separator.
โข Label has only text. Entry has default_text + variable mapping.
โข Button caption is explicit via text=..., so command parsing stays stable.
โข `WIN show` blocks script flow until the window is closed.
EXAMPLES:
WIN create||main||520||280||100||100
WIN label||main||180||24||20||20||Name:
WIN entry||main||220||24||20||50||||username
WIN checkbox||main||220||24||20||85||Admin||is_admin||0
WIN radiobutton||main||120||24||20||115||A||choice||A||1
WIN radiobutton||main||120||24||150||115||B||choice||B||0
WIN button||main||220||30||20||155||WIN get||main::LOG User=%username% Admin=%is_admin% Choice=%choice%
WIN button||main||220||30||20||190||text=Save||WIN get||main::LOG Saved %username%::WIN close||main
WIN show||main
๐ Usage:
WIN create||name||width||height||x||y
๐ก Examples:
WIN create||main||520||280||100||100
WIN label||main||180||24||20||20||Name:
WIN entry||main||220||24||20||50||||username
WIN checkbox||main||220||24||20||85||Admin||is_admin||0
WIN radiobutton||main||120||24||20||115||A||choice||A||1
๐ Pro Tips:
Check the documentation for advanced usage patterns
WJS
Data Formats & Apis
WJS - Write JSON
Writes JSON data to a file. Supports pretty or compact formatting and updating specific paths in existing JSON files.
Usage:
WJS file|data|[format]|[path]
Data: JSON string or variable containing JSON
Format: PRETTY or COMPACT (default: PRETTY)
Path: Optional path to update part of existing JSON
๐ Usage:
WJS file|data|[format]|[path]
๐ก Examples:
WJS example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
WND
Control Flow & Logic
WND - While End Marker
Marks the end of a WHI block.
Usage:
WHI %var%|<|10
LOG %var%
CAL var|+|1
WND
Note:
WND is handled by the WHI parser and does not execute logic by itself.
๐ Usage:
WND
๐ก Examples:
WND example_parameter
๐ Pro Tips:
Window management: minimize, maximize, close, restore applications.
WRF
General
WRF - Write File
Writes content to a file.
Usage:
WRF File|Content
๐ Usage:
WRF File|Content
๐ก Examples:
WRF example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
WRL
General
WRL - Write/Replace Line
Writes or replaces a specific line in a file.
Usage:
WRL File|LineNumber|Content
๐ Usage:
WRL File|LineNumber|Content
๐ก Examples:
WRL example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
WXM
Data Formats & Apis
WXM - Write XML
Writes XML data to a file. Supports pretty or compact formatting. Data is provided as JSON or from a variable.
Usage:
WXM file|root_element|data|[format]
Data: JSON string or variable containing JSON
Format: PRETTY or COMPACT (default: PRETTY)
๐ Usage:
WXM file|root_element|data|[format]
๐ก Examples:
WXM example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ ๐ Z-Commands
ZIP
File & Directory Operations
ZIP - Zip or Unzip
Compresses files, folders, or glob matches into an archive, or extracts one.
Usage:
ZIP ZIP|archive.zip|file_or_folder|...
ZIP UNZIP|archive.zip|output_folder
Examples:
ZIP ZIP|backup.zip|document.txt|images
ZIP ZIP|source.zip|*.py
ZIP UNZIP|backup.zip|C:\Restore
๐ Usage:
ZIP ZIP|archive.zip|file_or_folder|...
๐ก Examples:
ZIP ZIP|backup.zip|document.txt|images
ZIP ZIP|source.zip|*.py
ZIP UNZIP|backup.zip|C:\Restore
๐ Pro Tips:
Use "ex" flag to exclude certain patterns. Supports recursive directory zipping.
๐ Control Flow & Logic
BRK
Control Flow & Logic
BRK - Break Command
Breaks out of the current loop (FOR, WHI) or aborts the current execution.
Usage:
BRK
๐ Usage:
BRK
๐ก Examples:
BRK example_parameter
๐ Pro Tips:
Breaks out of current loop. Can be conditional with comparison operators.
END
Control Flow & Logic
END - End / Return
Closes a multiline IFC block. Inside a SUB or keyboard callback, END returns
from the current routine.
Usage:
END
Examples:
IFC %ready%|=|1
LOG Ready
END
SUB cleanup
END # Return from the current subroutine
๐ Usage:
END
๐ก Examples:
END
๐ Pro Tips:
Terminates script execution. Use exit codes: 0=success, 1=error.
FOR
Control Flow & Logic
FOR - For Loop
Creates a FOR loop. Iterates over a range and executes a block of commands.
Usage:
FOR Variable|Start|End|[Step]\n\nEXAMPLES:\n FOR i|1|10::LOG Processing item %i%::NXT i\n FOR file|*.txt::LOG Found: %file%::NXT file\n FOR x|1|5::CAL result|%x%|*|2::LOG %x% * 2 = %result%::NXT x\n
๐ Usage:
FOR Variable|Start|End|[Step]\n\nEXAMPLES:\n FOR i|1|10::LOG Processing item %i%::NXT i\n FOR file|*.txt::LOG Found: %file%::NXT file\n FOR x|1|5::CAL result|%x%|*|2::LOG %x% * 2 = %result%::NXT x\n
๐ก Examples:
\n FOR i|1|10::LOG Processing item %i%::NXT i\n FOR file|*.txt::LOG Found: %file%::NXT file\n FOR x|1|5::CAL result|%x%|*|2::LOG %x% * 2 = %result%::NXT x\n
๐ Pro Tips:
Use :: as separator between loop parts. Supports file wildcards and numeric ranges.
GOT
Control Flow & Logic
GOT - Go To
Usage:
GOT line_number
GOT label
๐ Usage:
GOT line_number
๐ก Examples:
GOT example_parameter
๐ Pro Tips:
Jump to labels. Use sparingly as it can make code hard to follow.
IFC
Control Flow & Logic
IFC - Conditional Execution
Runs commands only when a comparison is true. Use `::` for inline commands or
place the commands on following lines and close the block with END.
Usage:
IFC left|operator|right
IFC left|operator|right::then_command::ELSE::else_command::END
IFC left||right||then_command||ELSE||else_command
IFC left||operator||right||then_command||ELSE||else_command
Operators:
=, ==, !=, <>, >, >=, <, <=
Examples:
IFC %name%||||BRK
IFC %score%||>=||50||LOG Passed||ELSE||LOG Failed
IFC %role%|=|admin::LOG Welcome::ELSE::LOG Access denied::END
IFC %a%|=|1|AND|%b%|>|5::LOG Both conditions are true::END
IFC NOT|%enabled%|=|true::LOG Disabled::END
Notes:
In the `||` short form, `IFC left||right` means `left = right`.
`ELSE` and `ELS` are accepted. Omit the ELSE part when it is not needed.
๐ Usage:
IFC left|operator|right
๐ก Examples:
IFC %name%||||BRK
IFC %score%||>=||50||LOG Passed||ELSE||LOG Failed
IFC %role%|=|admin::LOG Welcome::ELSE::LOG Access denied::END
IFC %a%|=|1|AND|%b%|>|5::LOG Both conditions are true::END
IFC NOT|%enabled%|=|true::LOG Disabled::END
๐ Pro Tips:
Operators: ==, !=, >, <, >=, <=, contains. Use || as separator for conditions.
LBL
Control Flow & Logic
LBL - Label
Defines a subroutine (label) for use with SUB calls. Supports inline and block definitions.
Usage:
LBL labelname
LBL labelname::command1::command2::End (inline)
๐ Usage:
LBL labelname
๐ก Examples:
LBL example_parameter
๐ Pro Tips:
Define labels for GOT jumps. Use descriptive names for better readability.
NXT
Control Flow & Logic
NXT - Next
Marks the end of a FOR loop body. It is consumed by the FOR parser and is not
executed as a standalone command.
Usage:
NXT variable
Examples:
FOR item|1|3
LOG Item %item%
NXT item
๐ Usage:
NXT variable
๐ก Examples:
NXT item
๐ Pro Tips:
Continue to next iteration in FOR/WHI loops. Like "continue" in other languages.
SUB
Control Flow & Logic
SUB - Subroutine Call
Calls a subroutine by name, with call depth protection and optional authentication for subroutine files.
Usage:
SUB subroutine_name\n\nEXAMPLES:\n SUB my_script.sub # Execute Fluxionix subscripts (.sub files) with relative/absolute paths.\n SUB automation\task.sub \n SUB %script_path% \n SUB subscripts\backup.sub \n
๐ Usage:
SUB subroutine_name\n\nEXAMPLES:\n SUB my_script.sub
๐ก Examples:
\n SUB my_script.sub # Execute Fluxionix subscripts (.sub files) with relative/absolute paths.\n SUB automation\task.sub \n SUB %script_path% \n SUB subscripts\backup.sub \n
๐ Pro Tips:
Execute Fluxionix subscripts. Supports relative and absolute paths.
WHI
Control Flow & Logic
WHI - While Loop
Creates a WHILE loop with condition checking. Supports operators <, >, <=, >=, ==, != and safety features.
Usage:
WHI %Variable%|Operator|Value
... commands ...
WND
Operators:
<, >, <=, >=, ==, !=
Logical Operators:
AND, OR, NOT
Control Commands:
BRK - Break out of the loop (exit loop immediately)
CNT - Continue to next iteration (skip remaining commands)
Examples:
WHI %counter%|<|10
LOG Counter is %counter%
CAL counter|+|1
WND
WHI %x%|>=|1|AND|%y%|<|20
LOG Both conditions true
CAL x|-|1
WND
WHI %status%|==|active|OR|%force%|==|true
LOG Processing...
SLP 1000
WND
WHI %running%|==|true
INP user_input|Enter command (exit to quit):
IFC %user_input%|==|exit::BRK::END
IFC %user_input%|==|skip::CNT::END
LOG Processing: %user_input%
WND
Safety Features:
โข Maximum iteration limit (default: 100)
โข Infinite loop detection\n\nEXAMPLES:\n WHI %counter%|<|100::CAL counter|%counter%|+|1::LOG Counter: %counter% # While loop with condition checking and command execution.\n WHI %running%|==|true::LOG Still running...::SLP 1000\n WHI %condition%|!=|exit::LOG Processing...::NXT\n
๐ Usage:
WHI %Variable%|Operator|Value
๐ก Examples:
WHI %counter%|<|10
๐ Pro Tips:
Always include a way to break the loop to avoid infinite loops.
WND
Control Flow & Logic
WND - While End Marker
Marks the end of a WHI block.
Usage:
WHI %var%|<|10
LOG %var%
CAL var|+|1
WND
Note:
WND is handled by the WHI parser and does not execute logic by itself.
๐ Usage:
WND
๐ก Examples:
WND example_parameter
๐ Pro Tips:
Window management: minimize, maximize, close, restore applications.
๐ Data Formats & Apis
DBQ
Data Formats & Apis
DBQ - Database Query (clear usage, no SQI required)
DBQ supports SQL Server and SQLite in one command.
SQI is optional. DBQ can auto-detect common local SQL Server instances.
Usage:
DBQ target|query|[output_variable]
DBQ query
FASTEST AND MOST CLEAR FORMAT:
DBQ target|query|[output_var]
TARGET RULES:
- SQL Server: target = database name
Example: DBQ sps|SELECT * FROM items
- SQLite: target = .db file path
Example: DBQ data.db|SELECT * FROM items
OPTIONAL OUTPUT VARIABLE:
- If output_var is set:
- SELECT: plain text row-array is stored in output_var[index]
and also output_var[index][Column]
- INSERT/UPDATE/DELETE: affected rows count is stored
EXAMPLES:
SQL Server (without SQI):
DBQ sps|SELECT TOP 10 * FROM items
DBQ sps|SELECT * FROM items|items_json
LOG %items_json[1]%
SQLite:
DBQ mydata.db|SELECT * FROM items
DBQ mydata.db|UPDATE items SET price=10|rows_changed
Query-only mode (uses context):
DBQ SELECT * FROM items
SQL SERVER NOTES:
- Credentials from context: SQLUSER, SQLPASS
- Server from context if present: SQLCOM / SQLCOMM / SQLIP
- If server is missing, DBQ tries common local instances automatically
RESULT VARIABLES ALWAYS AVAILABLE:
- db_result_json
- db_result_count
- db_affected_rows
- db_last_insert_id
ARRAY OUTPUT NOTES (for output_var in SELECT):
- output_var[0] = row count
- output_var[1] = first row as plain text (e.g. id=1 | name=Box A)
- output_var[1][id] = first row, column id
๐ Usage:
DBQ target|query|[output_variable]
๐ก Examples:
DBQ sps|SELECT * FROM items
๐ Pro Tips:
Check the documentation for advanced usage patterns
RJS
Data Formats & Apis
RJS - Read JSON
Reads a JSON file, extracts data using a path, and stores the result in a variable. Supports nested objects and arrays.
Usage:
RJS file|path|variable|[default]
๐ Usage:
RJS file|path|variable|[default]
๐ก Examples:
RJS example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
RXM
Data Formats & Apis
RXM - Read XML (๐)
Reads an XML file, extracts data using XPath expressions, and stores the result in a variable.
Supports element text content and attributes. Multiple matches are stored as JSON array.
Usage:
RXM file|xpath|variable|[attribute]
Parameters:
file - Path to the XML file
xpath - XPath expression to locate elements
variable - Variable name to store the result
attribute - (Optional) Attribute name to extract instead of text content
XPath Features:
- Basic paths: tag/subtag/element
- Wildcards: */element or tag/*
- Conditions: element[@attribute='value'] or element[@attribute]
- Root paths: /root/element or root/element
Stored Variables:
{variable} - The extracted value(s) (string or JSON array)
{variable}_count - Number of elements found
Examples:
Example XML (config.xml):
admin
secret
Basic element text:
RXM config.xml|database/user|db_user
โ Stores "admin" in db_user
Extract attribute:
RXM config.xml|database|db_host|host
โ Stores "localhost" in db_host
Multiple elements:
RXM config.xml|servers/server|server_list|name
โ Stores ["web1", "web2"] as JSON in server_list
โ Sets server_list_count = "2"
With condition:
RXM config.xml|servers/server[@name='web1']|web1_server|ip
โ Stores "192.168.1.10" in web1_server
Wildcard:
RXM config.xml|*/user|username
โ Finds user element anywhere under root
Notes:
- Single match: Stores value as string
- Multiple matches: Stores as JSON array
- No match: Stores empty string ""
- Always sets {variable}_count
- Supports variable substitution in file, xpath, and attribute parameters
๐ Usage:
RXM file|xpath|variable|[attribute]
๐ก Examples:
RXM example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
WJS
Data Formats & Apis
WJS - Write JSON
Writes JSON data to a file. Supports pretty or compact formatting and updating specific paths in existing JSON files.
Usage:
WJS file|data|[format]|[path]
Data: JSON string or variable containing JSON
Format: PRETTY or COMPACT (default: PRETTY)
Path: Optional path to update part of existing JSON
๐ Usage:
WJS file|data|[format]|[path]
๐ก Examples:
WJS example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
WXM
Data Formats & Apis
WXM - Write XML
Writes XML data to a file. Supports pretty or compact formatting. Data is provided as JSON or from a variable.
Usage:
WXM file|root_element|data|[format]
Data: JSON string or variable containing JSON
Format: PRETTY or COMPACT (default: PRETTY)
๐ Usage:
WXM file|root_element|data|[format]
๐ก Examples:
WXM example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ Database
SQV
Database
SQV - SQL Server Version Year
Extracts the SQL Server version year (e.g., 2019, 2022) from the connected server.
Usage:
SQV variable_name # Store version year in variable
SQV # Display version year only
Examples:
SQV sql_year # Stores "2019" in sql_year
SQV # Displays: SQL Server version: 2019
Context Variables Used:
SQLCOM/SQLCOMM/SQLIP - SQL Server instance
SQLDB - Database name
SQLUSER/SQLPASS - SQL Server credentials
Version Detection:
SQL Server 2022 โ 2022
SQL Server 2019 โ 2019
SQL Server 2017 โ 2017
SQL Server 2016 โ 2016
SQL Server 2014 โ 2014
SQL Server 2012 โ 2012
SQL Server 2008 โ 2008
๐ Usage:
SQV variable_name
๐ก Examples:
SQV sql_year # Stores "2019" in sql_year
SQV # Displays: SQL Server version: 2019
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ Development
DOC
Development
๐ DOC - Documentation Generator
Generates comprehensive documentation for all Fluxionix commands and functions.
USAGE:
DOC [FORMAT] [OUTPUT_FILE]
FORMATS:
๐ HTML - Interactive HTML documentation (default)
๐ TXT - Plain text documentation
๐ฅ QUICK - Quick reference
EXAMPLES:
DOC HTML docs.html
DOC TXT manual.txt
DOC QUICK
FEATURES:
โข Interactive HTML with search functionality
โข Plain text output for console viewing
โข Command categorization and examples
๐ Usage:
DOC [FORMAT] [OUTPUT_FILE]
๐ก Examples:
DOC HTML docs.html
DOC TXT manual.txt
DOC QUICK
๐ Pro Tips:
Generates comprehensive documentation in HTML or TXT format.
๐ Development & Testing
ADD
Development & Testing
ADD - Addon Function Call
Loads a `.py` or `.pyd` file from the `addon` folder, calls one of its functions,
and stores the return value in a variable.
Usage:
ADD variable|addon_file|function|argument1|argument2|...
Examples:
ADD result|BigBen|calculate|10|20
ADD status|SPS.py|check_status
Notes:
The addon filename may be written with or without `.py` or `.pyd`.
๐ Usage:
ADD variable|addon_file|function|argument1|argument2|...
๐ก Examples:
ADD result|BigBen|calculate|10|20
ADD status|SPS.py|check_status
๐ Pro Tips:
Call functions from Python libraries. Auto-imports modules as needed.
DBG
Development & Testing
DBG - Debug Information
Shows debug and interpreter information about Fluxionix, including version, debug mode, logging, cache, variables, and error history.
Usage:
DBG INFO # General debug information
DBG VARS # Show all user-defined variables
DBG ERRORS # Show last error
DBG EXPORT [filename]# Export debug info to file
DBG CLEAR [target] # Clear cache, variables, stats, or errors
DBG TRACE [ON|OFF] # Enable/disable debug tracing
DBG MEMORY # Show memory usage info
Available targets for CLEAR: CACHE, VARS, STATS, ERRORS\n\nEXAMPLES:\n DBG on # Toggle debug mode for detailed execution information.\n DBG off \n DBG status \n
๐ Usage:
DBG INFO
๐ก Examples:
\n DBG on # Toggle debug mode for detailed execution information.\n DBG off \n DBG status \n
๐ Pro Tips:
Debug mode shows detailed execution information. Toggle with "on"/"off".
REQ
Development & Testing
REQ - Version Requirement
Checks if the current interpreter version is greater than or equal to the required version. Exits if not met.
Usage:
REQ Version
๐ Usage:
REQ Version
๐ก Examples:
REQ example_parameter
๐ Pro Tips:
Enable debug mode for detailed execution information
THR
Development & Testing
THR - Thread
Simple thread management for parallel execution. Supports starting a thread with a command and listing active threads.
Usage:
THR START|name|command # Start a new thread named 'name' running 'command'
THR LIST # List all active threads
Examples:
THR START|MyThread|SUB MYSUB
THR LIST
๐ Usage:
THR START|name|command
๐ก Examples:
THR START|MyThread|SUB MYSUB
THR LIST
๐ Pro Tips:
Enable debug mode for detailed execution information
VER
Development & Testing
VER - Version
Outputs the interpreter version via LOG.py or stores it in a variable. Also sets the window title on Windows.
Usage:
VER [var]\n\nEXAMPLES:\n VER # Display version information for Fluxionix, Python, and system components.\n VER system \n VER python \n VER fluxionix \n
๐ Usage:
VER [var]\n\nEXAMPLES:\n VER
๐ก Examples:
\n VER # Display version information for Fluxionix, Python, and system components.\n VER system \n VER python \n VER fluxionix \n
๐ Pro Tips:
Shows version information for Fluxionix, Python, and system components.
๐ File & Directory Operations
CRF
File & Directory Operations
CRF - Create Folder (๐)
Creates a new folder (directory) at the specified path.
Automatically creates parent directories if they don't exist.
Usage:
CRF folder_path
Features:
โข Creates single or nested directory structures
โข Safe: Won't fail if folder already exists
โข Creates parent directories automatically
โข Variable substitution support
โข Cross-platform path handling
Examples:
Simple Folder:
CRF new_folder # Create in current directory
CRF data # Create 'data' folder
Nested Directories:
CRF projects\\python\\scripts # Create nested structure (Windows)
CRF projects/python/scripts # Create nested structure (Linux/Mac)
CRF C:\\Users\\John\\Documents\\Work # Full path (Windows)
With Variables:
SET project|MyApp
CRF %project% # Create folder from variable
CRF %project%\\data # Create subfolder
CRF %project%\\logs
Build Directory Structure:
CRF src\\components
CRF src\\utils
CRF tests\\unit
CRF tests\\integration
Common Use Cases:
Project Setup:
CRF MyProject\\src
CRF MyProject\\docs
CRF MyProject\\tests
Data Organization:
CRF data\\input
CRF data\\output
CRF data\\backups
Notes:
โข No error if folder already exists (safe to run multiple times)
โข All parent directories created automatically
โข Use backslashes (\\) for Windows, forward slashes (/) for Linux/Mac
โข Relative or absolute paths supported
โข Permissions inherited from parent directory
๐ Usage:
CRF folder_path
๐ก Examples:
CRF new_folder # Create in current directory
CRF data # Create 'data' folder
CRF projects\\python\\scripts # Create nested structure (Windows)
CRF projects/python/scripts # Create nested structure (Linux/Mac)
CRF C:\\Users\\John\\Documents\\Work # Full path (Windows)
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
FID
File & Directory Operations
FID - File Selection Dialog
Opens a native file picker and stores the selected path in a variable. If the
dialog is cancelled, the variable is set to an empty string.
Usage:
FID [variable|title|extension_pattern]
Examples:
FID # Store the selection in %last_file%
FID document|Open document|*.txt # Store a text-file selection in %document%
FID image|Choose image|*.png;*.jpg # Allow multiple file patterns
๐ Usage:
FID [variable|title|extension_pattern]
๐ก Examples:
FID # Store the selection in %last_file%
FID document|Open document|*.txt # Store a text-file selection in %document%
FID image|Choose image|*.png;*.jpg # Allow multiple file patterns
๐ Pro Tips:
Finds files and directories by name. Returns full paths for found items.
FIE
File & Directory Operations
FIE - File Exists
Stores `true` or `false` depending on whether a file exists.
Usage:
FIE variable|filepath
Examples:
FIE config_exists|config.txt
FIE editor_exists|C:\Windows\System32\notepad.exe
๐ Usage:
FIE variable|filepath
๐ก Examples:
FIE config_exists|config.txt
FIE editor_exists|C:\Windows\System32\notepad.exe
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
FOD
File & Directory Operations
FOD - Folder Dialog (๐)
Opens a graphical folder selection dialog and stores the selected path in a variable.
User-friendly way to let users browse and select directories.
Usage:
FOD [variable|title]
FOD [variable]
FOD
Parameters:
variable - Variable name to store selected path (default: 'last_folder')
title - Dialog window title (default: 'Select Folder')
Features:
โข Native OS folder browser dialog
โข Stores full absolute path
โข Empty string if user cancels
โข Custom variable name support
โข Custom dialog title
โข Cross-platform compatible
Examples:
Basic Usage:
FOD # Store in 'last_folder' variable
LOG Selected: %last_folder%
Custom Variable:
FOD backup_dir # Store in 'backup_dir' variable
LOG Backup path: %backup_dir%
Custom Variable and Title:
FOD project_path|Select Project Root
LOG Project: %project_path%
FOD output_dir|Choose Output Location
CRF %output_dir%\\results
Practical Examples:
Select Backup Location:
FOD backup_location|Select Backup Folder
IFC %backup_location%|==|
LOG No folder selected!
QUT
FIL
LOG Backing up to: %backup_location%
Choose Work Directory:
FOD work_dir|Select Working Directory
SET original_dir|%CD%
CMD cd %work_dir%
# Do work here...
CMD cd %original_dir%
Variable Contents:
โข Selected path: Full absolute path (e.g., C:\\Users\\John\\Documents)
โข User cancelled: Empty string ""
Notes:
โข Dialog is modal (blocks script execution until user responds)
โข Returns empty string if user clicks Cancel
โข Path always uses OS-appropriate separators
โข Variable can be used immediately after dialog closes
โข Works on Windows, Linux (with Tkinter), and Mac
๐ Usage:
FOD [variable|title]
๐ก Examples:
FOD # Store in 'last_folder' variable
FOD backup_dir # Store in 'backup_dir' variable
FOD project_path|Select Project Root
FOD output_dir|Choose Output Location
๐ Pro Tips:
Creates directories recursively if they don't exist. Use forward slashes for cross-platform compatibility.
FOE
File & Directory Operations
FOE - Folder Exists
Checks if a specified folder exists and stores the result (true/false) in a variable.
Usage:
FOE var|folderpath
๐ Usage:
FOE var|folderpath
๐ก Examples:
FOE example_parameter
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
GEL
File & Directory Operations
GEL - Get Line Number
Finds the line number where specified content appears in a file and stores it in a variable.
Usage:
GEL Variable|File|Content
๐ Usage:
GEL Variable|File|Content
๐ก Examples:
GEL example_parameter
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
LOC
File & Directory Operations
LOC - Locate (Cursor)
Moves the cursor to the specified x,y coordinates in the terminal (Windows only).
Usage:
LOC x|y
x = column (1-based), y = row (1-based)
๐ Usage:
LOC x|y
๐ก Examples:
LOC example_parameter
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
REF
File & Directory Operations
REF - Read File Line
Reads one 1-based line from a UTF-8 file into a variable. It can optionally
extract a character range and replace text in the extracted value.
Usage:
REF variable|file|line|[from]|[to]|[search]|[replace]
Examples:
REF line|User.txt|1
REF name|User.txt|1|1|12
REF cleaned|User.txt|2|1|100|old|new
Notes:
A missing file or line sets the target variable to an empty value.
๐ Usage:
REF variable|file|line|[from]|[to]|[search]|[replace]
๐ก Examples:
REF line|User.txt|1
REF name|User.txt|1|1|12
REF cleaned|User.txt|2|1|100|old|new
๐ Pro Tips:
Quick reference for commands. Use specific command name for detailed help.
RSF
File & Directory Operations
RSF - Replace String in File (๐)
Replaces a substring in a file with another string. Search is case-insensitive by default.
Usage:
RSF FileName|SearchText|ReplaceText[|case]
Options:
case - Add 'case' as 4th parameter for case-sensitive search
Examples:
RSF test.txt|hello|goodbye - Case-insensitive: replaces Hello, HELLO, hello
RSF test.txt|hello|goodbye|case - Case-sensitive: replaces only hello
๐ Usage:
RSF FileName|SearchText|ReplaceText[|case]
๐ก Examples:
RSF test.txt|hello|goodbye - Case-insensitive: replaces Hello, HELLO, hello
RSF test.txt|hello|goodbye|case - Case-sensitive: replaces only hello
๐ Pro Tips:
Use absolute paths when possible to avoid path issues
SEA
File & Directory Operations
SEA - Search File or Folder
Searches recursively for an exact file or folder name. A single match is stored;
when several matches exist, SEA asks which one to use.
Usage:
SEA variable|exact_name|location
Examples:
SEA config_path|settings.ini|C:\Config
SEA script_path|run.py|C:\Scripts
๐ Usage:
SEA variable|exact_name|location
๐ก Examples:
SEA config_path|settings.ini|C:\Config
SEA script_path|run.py|C:\Scripts
๐ Pro Tips:
Searches files and content. Supports regex patterns and multiple search locations.
ZIP
File & Directory Operations
ZIP - Zip or Unzip
Compresses files, folders, or glob matches into an archive, or extracts one.
Usage:
ZIP ZIP|archive.zip|file_or_folder|...
ZIP UNZIP|archive.zip|output_folder
Examples:
ZIP ZIP|backup.zip|document.txt|images
ZIP ZIP|source.zip|*.py
ZIP UNZIP|backup.zip|C:\Restore
๐ Usage:
ZIP ZIP|archive.zip|file_or_folder|...
๐ก Examples:
ZIP ZIP|backup.zip|document.txt|images
ZIP ZIP|source.zip|*.py
ZIP UNZIP|backup.zip|C:\Restore
๐ Pro Tips:
Use "ex" flag to exclude certain patterns. Supports recursive directory zipping.
๐ Files
FIL
Files
FIL - File Management
Performs advanced file management operations: copy, move, delete, rename, attributes, size, date, permissions.
USAGE:
FIL action|file|[target]|[options]
ACTIONS:
COPY, MOVE, DELETE, RENAME, ATTRIBUTES, SIZE, DATE, PERMISSIONS
EXAMPLES:
FIL documents|C:\\\\Users\\\\%USERNAME%\\\\Documents
FIL temp_files|*.tmp
FIL config_file|settings.ini
FIL project_files|*.py
๐ Usage:
FIL action|file|[target]|[options]
๐ก Examples:
FIL documents|C:\\\\Users\\\\%USERNAME%\\\\Documents
FIL temp_files|*.tmp
FIL config_file|settings.ini
FIL project_files|*.py
๐ Pro Tips:
Supports wildcards (*,?). Use absolute paths to avoid confusion.
๐ General
CMD
General
CMD - Execute Shell Command (๐ป)
Executes system shell commands directly from the script.
Supports variable substitution and cross-platform commands.
Usage:
CMD command [arguments]
Features:
โข Direct system command execution
โข Variable substitution support
โข Pipe and redirection support
โข Cross-platform compatibility
โข Output displayed in console
Platform-Specific Commands:
Windows:
CMD dir # List directory contents
CMD tasklist | findstr python # Find Python processes
CMD ipconfig /all # Network configuration
CMD echo %PATH% # Show PATH variable
Linux/Mac:
CMD ls -la # List directory contents
CMD ps aux | grep python # Find Python processes
CMD ifconfig # Network configuration
CMD echo $PATH # Show PATH variable
Common Examples:
CMD ping google.com -n 4 # Ping with 4 packets
CMD mkdir new_folder # Create directory
CMD curl https://api.example.com # Make HTTP request
CMD %custom_command% # Execute from variable
CMD git status # Check git repository status
CMD python script.py # Run Python script
CMD npm install # Install npm packages
With Variables:
SET server|example.com
CMD ping %server% # Ping server from variable
SET path|C:\\Projects
CMD cd %path% && dir # Navigate and list
Notes:
โข Command output goes to console directly
โข Return codes are not captured
โข Commands run in system shell environment
โข Use appropriate shell syntax for your OS
โข For complex commands, consider using script files
โข Pipes (|) and redirections (>, <) are supported
๐ Usage:
CMD command [arguments]
๐ก Examples:
CMD ping google.com -n 4 # Ping with 4 packets
CMD mkdir new_folder # Create directory
CMD curl https://api.example.com # Make HTTP request
CMD %custom_command% # Execute from variable
CMD git status # Check git repository status
๐ Pro Tips:
Executes system commands. Output is captured and can be stored in variables.
CNT
General
CNT - Continue Command
Skips the remaining commands in the current loop iteration and continues to the next iteration.
Usage:
CNT
Examples:
FOR i|1|10
IFC %i%|==|5::CNT::END
LOG Counter: %i%
LOG This won't show for i=5
NXT
WHI %running%|==|true
INP user_input|Enter command:
IFC %user_input%|==|skip::CNT::END
LOG Processing: %user_input%
WND
The CNT command works in:
โข FOR loops (with NXT)
โข WHI loops (with WND)
Note: CNT only works inside loops. Outside of loops, it has no effect.
๐ Usage:
CNT
๐ก Examples:
IFC %i%|==|5::CNT::END
๐ Pro Tips:
Check the documentation for advanced usage patterns
CRY
General
CRY - Encrypt Value
Encrypts values with Fluxionix built-in encryption (no external crypto dependency).
Usage:
CRY variable|plain_text
CRY variable|plain_text|must_contain
CRY plain_text
Notes:
- Stored tokens use ASS2 prefix.
- Existing legacy ASS tokens are still decryptable by helper functions.
๐ Usage:
CRY variable|plain_text
๐ก Examples:
CRY example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
FIN
General
FIN - FIND TEXT IN FILE (๐)
Searches for text or patterns in files or directories. Supports regex, case-insensitive, and directory search.
USAGE:
FIN pattern|file|[flags]
FLAGS:
i = ignore case (case-insensitive search)
r = regex (use regular expressions for searching)
d = directory search (search all files in a directory)
If you provide a folder as the file argument and use the d flag (e.g. FIN pattern|folder|d), FIN will search for the pattern in all files within that folder (recursively).
You can combine flags, e.g. 'ir' for case-insensitive regex search.
EXAMPLES:
FIN error|logfile.txt # Find "error" in logfile.txt
FIN TODO|*.py|i # Find "TODO" in all .py files (ignore case)
FIN function|source_code|r # Find "function" using regex in source_code
FIN \\d{4}|data.txt|ir # Find 4 digits, case-insensitive regex
FIN exception|C:\\Logs|d # Find "exception" in all files in C:\\Logs
๐ Usage:
FIN pattern|file|[flags]
๐ก Examples:
FIN error|logfile.txt # Find "error" in logfile.txt
FIN TODO|*.py|i # Find "TODO" in all .py files (ignore case)
FIN function|source_code|r # Find "function" using regex in source_code
FIN \\d{4}|data.txt|ir # Find 4 digits, case-insensitive regex
FIN exception|C:\\Logs|d # Find "exception" in all files in C:\\Logs
๐ Pro Tips:
Use flags: i=ignore case, r=regex, d=directory search. Combine flags like "ir".
MAX
General
MAX - Maximum of Array
Gets the largest value from array-like entries (arr[1..n]) and stores it.
Usage:
MAX target|array
๐ Usage:
MAX target|array
๐ก Examples:
MAX example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
MEN
General
MEN - Menu (tkinter GUI)
Displays a graphical menu of options and returns the user's selection.
Usage:
MEN TITLE||OPTION1||COMMAND1||OPTION2||COMMAND2 ...
Arguments:
TITLE: Window title and prompt text (first argument).
OPTION||COMMAND: Button label and command to return, alternating pairs after the title.
Splitter usage:
Use '||' between menu items (title, options, commands).
Single '|' is allowed inside commands (e.g. SET A|1), but not between menu items.
Examples:
MEN Choose an option||Yes||LOG Yes||No||LOG No||Cancel||LOG Cancel
MEN Set value||Zero||SET A|0||One||SET A|1
Options are shown as buttons in a window. The selected command is returned.\n\nEXAMPLES:\n MEN choice|Select option|Option 1,Option 2,Option 3 # Display interactive menu with selectable options.\n MEN action|Choose action|Create,Edit,Delete,Exit\n MEN %variable%|%prompt%|%options% \n
๐ Usage:
MEN TITLE||OPTION1||COMMAND1||OPTION2||COMMAND2 ...
๐ก Examples:
MEN Choose an option||Yes||LOG Yes||No||LOG No||Cancel||LOG Cancel
MEN Set value||Zero||SET A|0||One||SET A|1
๐ Pro Tips:
Returns selected index starting from 1. Use comma-separated options.
MIN
General
MIN - Minimum of Array
Gets the smallest value from array-like entries (arr[1..n]) and stores it.
Usage:
MIN target|array
๐ Usage:
MIN target|array
๐ก Examples:
MIN example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
PLY
General
PLY - Play Alert Sound (๐)
Plays or stops a continuous warning/alert sound.
Useful for drawing attention or signaling important events.
Usage:
PLY ON # Start playing alert sound (loops)
PLY OFF # Stop the alert sound
Features:
โข Continuous looping sound until stopped
โข Non-blocking (script continues while playing)
โข Platform-specific sound implementation
โข Thread-safe start/stop
โข Automatic cleanup on exit
Sound Behavior:
Windows: Plays ascending beep tones (1000-5000 Hz)
Linux/Mac: System bell/alert sound
Examples:
Simple Alert:
LOG Starting critical process...
PLY ON # Start alert sound
# ... long running process ...
PLY OFF # Stop alert sound
LOG Process complete!
Error Notification:
IFC %error_count%|>|0
PLY ON
LOG WARNING: %error_count% errors detected!
SLP 5
PLY OFF
FIL
Timed Alert:
PLY ON
LOG System maintenance in progress...
SLP 10 # Alert for 10 seconds
PLY OFF
LOG Maintenance complete
Monitoring Loop:
FOR i|1|100
# Check some condition
IFC %status%|==|critical
PLY ON
LOG CRITICAL: System issue detected!
ANY # Wait for acknowledgment
PLY OFF
FIL
SLP 1
NXT
Practical Use Cases:
Long Process Notification:
LOG Starting backup...
# ... backup process ...
PLY ON
LOG Backup complete! Press any key.
ANY
PLY OFF
Multiple Alerts:
IFC %disk_full%|==|1
PLY ON
LOG ERROR: Disk is full!
SLP 3
PLY OFF
FIL
Notes:
โข Sound plays in background thread
โข Only one alert can play at a time
โข Starting when already playing has no effect
โข Stopping when not playing has no effect
โข Sound automatically stops when script ends
โข May require audio hardware/drivers
โข Volume controlled by system settings
๐ Usage:
PLY ON
๐ก Examples:
PLY ON # Start alert sound
PLY OFF # Stop alert sound
PLY ON
PLY OFF
PLY ON
๐ Pro Tips:
Supports audio/video files and streaming URLs. Use system default media player.
SQI
General
SQI - SQL Instances
Checks for Microsoft SQL Server instances on Windows. Compatible with OldAchoo SQLInstances.
Usage:
SQI Variable|Version
๐ Usage:
SQI Variable|Version
๐ก Examples:
SQI example_parameter
๐ Pro Tips:
Execute SQL queries on SQLite databases. Supports SELECT, INSERT, UPDATE, DELETE.
SRT
General
SRT - Sort Array
Sorts Fluxionix array-like entries such as arr[1], arr[2], ... using arr[0] as count.
Usage:
SRT array
SRT array|asc
SRT array|desc
SRT array|asc|target_array
Notes:
- If target_array is omitted, sorting happens in-place.
- Sorting is numeric when all values are numbers; otherwise string sort is used.
๐ Usage:
SRT array
๐ก Examples:
SRT example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
SSH
General
SSH - Secure Shell Remote Access
Advanced SSH client for secure remote command execution, file transfer,
and system administration over encrypted connections.
USAGE:
SSH host|user|password|command # Execute remote command
SSH host|user|password|UPLOAD|local|remote # Upload file via SFTP
SSH host|user|password|DOWNLOAD|remote|local # Download file via SFTP
SSH host|user|password|SHELL # Interactive SSH shell session
๐ฏ ADVANCED FEATURES:
โข ๐ Secure remote command execution
โข ๐ SFTP file transfer (upload/download)
โข ๐ฅ๏ธ Interactive shell sessions
โข ๐ Password and key-based authentication
โข โฑ๏ธ Configurable connection timeout
โข ๐ก๏ธ Host key verification and management
โข ๐ Connection status monitoring
โข ๐ Error handling and retry logic
โ๏ธ CONNECTION OPTIONS:
host - Remote server IP/hostname
user - SSH username
password - SSH password (or key file path)
port - SSH port (default: 22)
timeout - Connection timeout in seconds
๐ EXAMPLES:
SSH 192.168.1.100|admin|secret|ls -la
SSH server.com|user|pass|UPLOAD|file.txt|/tmp/file.txt
SSH 10.0.0.1|root|key.pem|DOWNLOAD|/var/log/app.log|./app.log
SSH myserver|user|password|SHELL
๐ง SECURITY NOTES:
โข Always use strong passwords or SSH keys
โข Verify host fingerprints on first connection
โข Use non-standard ports when possible
โข Enable key-based authentication for production
๐ Usage:
SSH host|user|password|command
๐ก Examples:
SSH 192.168.1.100|admin|secret|ls -la
SSH server.com|user|pass|UPLOAD|file.txt|/tmp/file.txt
SSH 10.0.0.1|root|key.pem|DOWNLOAD|/var/log/app.log|./app.log
SSH myserver|user|password|SHELL
๐ Pro Tips:
Use "interactive" mode for shell access. Supports key-based authentication.
STP
General
STP - Setup
Opens the setup configuration menu for Fluxionix with explicit save confirmation.
Usage:
STP # Open interactive setup menu
STP EMAIL # Quick email setup wizard
Notes:
- Type CANCEL at any prompt to abort without saving changes.
- WEB output mode is deprecated and no longer offered in setup.
๐ Usage:
STP
๐ก Examples:
STP example_parameter
๐ Pro Tips:
Use process name or PID. Be careful with system processes!
STR
General
STR - Variable Stripping
Strips characters from a variable and updates it, routing all output via LOG.py.
Usage:
STR var|l|N # Removes N characters from the left of variable 'var'
STR var|r|N # Removes N characters from the right of variable 'var'
Examples:
STR myvar|l|3 # Updates 'myvar' by removing 3 characters from the left
STR myvar|r|2 # Updates 'myvar' by removing 2 characters from the right\n\nEXAMPLES:\n STR result|Hello World|upper\n STR filename|document.txt|replace|txt|pdf\n STR text| spaces |strip\n STR words|Hello World|split| \n
๐ Usage:
STR var|l|N
๐ก Examples:
STR myvar|l|3 # Updates 'myvar' by removing 3 characters from the left
STR myvar|r|2 # Updates 'myvar' by removing 2 characters from the right\n\nEXAMPLES:\n STR result|Hello World|upper\n STR filename|document.txt|replace|txt|pdf\n STR text| spaces |strip\n STR words|Hello World|split| \n
๐ Pro Tips:
Available operations: upper, lower, strip, replace, split, join, length.
WRF
General
WRF - Write File
Writes content to a file.
Usage:
WRF File|Content
๐ Usage:
WRF File|Content
๐ก Examples:
WRF example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
WRL
General
WRL - Write/Replace Line
Writes or replaces a specific line in a file.
Usage:
WRL File|LineNumber|Content
๐ Usage:
WRL File|LineNumber|Content
๐ก Examples:
WRL example_parameter
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ Gui
WIN
Gui
WIN - Basic GUI Builder (Tkinter)
Creates simple GUI windows and controls that integrate with Fluxionix variables.
SEPARATORS:
Preferred: || (recommended for commands/text with |)
Legacy: |
USAGE:
WIN create||name||width||height||x||y
WIN label||name||width||height||x||y||text
WIN entry||name||width||height||x||y||default_text||variable
WIN button||name||width||height||x||y||command
WIN button||name||width||height||x||y||text=caption||command
WIN checkbox||name||width||height||x||y||text||variable||checked
WIN radiobutton||name||width||height||x||y||text||variable||value||selected
WIN get||name
WIN show||name
WIN close||name
NOTES:
โข `WIN get` writes entry/check/radio values into their mapped Fluxionix variables.
โข `WIN button` executes Fluxionix command(s). Use :: for multiple commands.
โข For command/text payloads that contain |, use || as separator.
โข Label has only text. Entry has default_text + variable mapping.
โข Button caption is explicit via text=..., so command parsing stays stable.
โข `WIN show` blocks script flow until the window is closed.
EXAMPLES:
WIN create||main||520||280||100||100
WIN label||main||180||24||20||20||Name:
WIN entry||main||220||24||20||50||||username
WIN checkbox||main||220||24||20||85||Admin||is_admin||0
WIN radiobutton||main||120||24||20||115||A||choice||A||1
WIN radiobutton||main||120||24||150||115||B||choice||B||0
WIN button||main||220||30||20||155||WIN get||main::LOG User=%username% Admin=%is_admin% Choice=%choice%
WIN button||main||220||30||20||190||text=Save||WIN get||main::LOG Saved %username%::WIN close||main
WIN show||main
๐ Usage:
WIN create||name||width||height||x||y
๐ก Examples:
WIN create||main||520||280||100||100
WIN label||main||180||24||20||20||Name:
WIN entry||main||220||24||20||50||||username
WIN checkbox||main||220||24||20||85||Admin||is_admin||0
WIN radiobutton||main||120||24||20||115||A||choice||A||1
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ Input
LOG
Input
๐ LOG - Advanced Multi-Target Output System
Intelligent output routing system supporting simultaneous output to multiple targets
with advanced formatting, variable expansion, and cross-platform compatibility.
USAGE:
LOG message # Output to current Console target(s)
LOG Processing file: %filename% # Variable expansion in messages
LOG User %username% logged in at %time%
๐ฏ OUTPUT TARGETS (controlled by Console variable):
cmd - Console/terminal output with colors
gui - Graphical user interface (FluxionixGUI)
file - File logging (fluxionix.log)
web - Web interface output
๐ MULTI-TARGET OUTPUT:
SET Console cmd,gui,file # Output to multiple targets
SET Console cmd gui web # Space-separated targets
SET Console cmd|gui|file # Pipe-separated targets
โก ADVANCED FEATURES:
โข ๐จ Automatic color coding and formatting
โข ๐ Variable expansion with nested support
โข ๐ Real-time output to multiple targets simultaneously
โข ๐ Cross-platform compatibility (Windows/Linux/macOS)
โข ๐ฏ Intelligent newline handling
โข ๐ Automatic duplicate line filtering
โข ๐ Debug and verbose output modes
โข โฑ๏ธ Timestamp integration
โข ๐ Emoji and Unicode support
๐ FORMATTING FEATURES:
โข Automatic newline normalization
โข ANSI color preservation in terminals
โข HTML formatting for web output
โข Markdown support for documentation
โข Code block formatting with syntax highlighting
๐จ EXAMPLES:
LOG Starting application...
LOG Current user: %username%
LOG Processing %file_count% files
LOG โ
Operation completed successfully!
LOG โ ๏ธ Warning: Low disk space (%free_space% GB)
LOG โ Error: Connection failed to %server%
LOG ๐ Statistics: %processed%/%total% completed
LOG ๐ฏ Performance: %operations% ops/sec
๐ ADVANCED USE CASES:
Multi-target logging:
SET Console cmd,file,web
LOG ๐ System startup initiated
Conditional output:
IFC %debug_mode%||==||1||LOG ๐ Debug: Variable %var% = %value%
Performance monitoring:
LOG โฑ๏ธ Benchmark started at %start_time%
BMK quick
LOG โ
Benchmark completed in %duration% seconds
File processing pipeline:
FOR file|*.txt::LOG ๐ Processing %file%::NXT file
๐ก PRO TIPS:
โข Use emojis and symbols for visual categorization
โข Variable expansion supports nested variables: %user_%role%%
โข Multi-target output is atomic - all targets receive the same message
โข File output automatically creates fluxionix.log if it doesn't exist
โข Web output requires WEB function to be configured
โข GUI output requires FluxionixGUI to be running and connected
๐ฏ INTEGRATION WITH OTHER COMMANDS:
โข Works seamlessly with all variable types (SET, GET, CAL)
โข Supports output from command execution (GET results)
โข Integrates with conditional logic (IFC, WHI, FOR)
โข Compatible with background processes and threading
โข Supports real-time monitoring and live updates
๐ง TECHNICAL DETAILS:
โข UTF-8 encoding for international character support
โข Efficient memory usage for large output volumes
โข Thread-safe operation for concurrent access
โข Configurable output buffering and flushing
โข Error handling with graceful fallbacks
๐ Usage:
LOG message
๐ก Examples:
LOG Starting application...
LOG Current user: %username%
LOG Processing %file_count% files
LOG โ
Operation completed successfully!
LOG โ ๏ธ Warning: Low disk space (%free_space% GB)
๐ Pro Tips:
Supports variable substitution. Output goes to console and log files if configured.
๐ Input & Output
ANY
Input & Output
ANY - Wait for Any Key Press (โณ)
Pauses script execution and waits for the user to press any key before continuing.
Displays a prompt message and captures the keypress without displaying it.
Usage:
ANY
Behavior:
โข Displays "Press any key to continue..." message
โข Waits indefinitely until any key is pressed
โข Does not echo the pressed key to console
โข Handles Ctrl+C and EOF gracefully
Use Cases:
โข Pause script execution for user review
โข Wait before proceeding to next step
โข Interactive script flow control
โข Debugging breakpoints in scripts
Examples:
LOG Starting process...
ANY # Wait for user confirmation
LOG Process continuing...
LOG Check the output above
ANY # Pause to review
CLS # Clear and continue
Notes:
โข Windows-specific (uses msvcrt module)
โข Pressing Ctrl+C will interrupt gracefully
โข Any key works: space, enter, letters, etc.
๐ Usage:
ANY
๐ก Examples:
ANY # Wait for user confirmation
ANY # Pause to review
๐ Pro Tips:
Randomly selects from comma-separated list. Useful for random choices.
CLS
Input & Output
CLS - Clear Screen (๐งน)
Clears the console window (cls on Windows, clear on Linux/Mac).
Usage:
CLS
Examples:
CLS # Clear the active terminal
๐ Usage:
CLS
๐ก Examples:
CLS # Clear the active terminal
๐ Pro Tips:
Clears console. Works on Windows (cls) and Unix-like systems (clear).
INP
Input & Output
INP - Input
Prompts the user for input and stores it in a variable.
Usage:
INP Variable|Prompt\n\nEXAMPLES:\n INP username|Enter your username\n INP age|How old are you?|number\n INP confirm|Continue? (y/n)|yesno\n INP password|Enter password|password\n
๐ Usage:
INP Variable|Prompt\n\nEXAMPLES:\n INP username|Enter your username\n INP age|How old are you?|number\n INP confirm|Continue? (y/n)|yesno\n INP password|Enter password|password\n
๐ก Examples:
\n INP username|Enter your username\n INP age|How old are you?|number\n INP confirm|Continue? (y/n)|yesno\n INP password|Enter password|password\n
๐ Pro Tips:
Input types: text (default), number, yesno, password. Supports default values.
QUE
Input & Output
QUE - Question
Prompts the user for input and stores the answer in context.
Usage:
QUE [question]
EXAMPLES:
QUE name|What is your name?
QUE age|How old are you?
QUE confirm|Do you want to continue?
๐ Usage:
QUE [question]
๐ก Examples:
QUE name|What is your name?
QUE age|How old are you?
QUE confirm|Do you want to continue?
๐ Pro Tips:
Queue commands for background execution. Useful for long-running tasks.
TIT
Input & Output
TIT - Title
Sets the window title (Windows only).
Usage:
TIT Title
๐ Usage:
TIT Title
๐ก Examples:
TIT example_parameter
๐ Pro Tips:
Sets console window title. Useful for progress indication in long-running scripts.
๐ Math
BIN
Math
BIN - Convert Number to Binary
Converts numeric input to a binary string.
USAGE:
BIN value
BIN target|value
INPUT SUPPORT:
Decimal: 42
Hex: 0x2A, 2Ah, 2A
Binary: 0b101010, 101010b
EXAMPLES:
BIN 255
BIN out|0xFF
BIN out|42
๐ Usage:
BIN value
๐ก Examples:
BIN 255
BIN out|0xFF
BIN out|42
๐ Pro Tips:
Check the documentation for advanced usage patterns
DEC
Math
DEC - Convert Number to Decimal
Converts binary or hexadecimal input to a decimal string.
USAGE:
DEC value
DEC target|value
INPUT SUPPORT:
Binary: 0b1010, 1010b, 1010
Hex: 0xFF, FFh, FF
EXAMPLES:
DEC 0b1010
DEC n|FF
DEC out|0x1A
๐ Usage:
DEC value
๐ก Examples:
DEC 0b1010
DEC n|FF
DEC out|0x1A
๐ Pro Tips:
Check the documentation for advanced usage patterns
HEX
Math
HEX - Convert Number to Hexadecimal
Converts binary or decimal input to an uppercase hexadecimal string.
USAGE:
HEX value
HEX target|value
INPUT SUPPORT:
Decimal: 42
Binary: 0b101010, 101010b
Hex passthrough: 0x2A, 2Ah, 2A
EXAMPLES:
HEX 42
HEX out|0b101010
HEX out|255
๐ Usage:
HEX value
๐ก Examples:
HEX 42
HEX out|0b101010
HEX out|255
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ Multimedia & Sound
SLP
Multimedia & Sound
SLP - Sleep/Pause (โธ๏ธ)
Pauses script execution for a specified duration in seconds.
Supports fractional seconds for precise timing.
Usage:
SLP seconds
Parameters:
seconds - Duration to pause (supports decimals)
Features:
โข Precise timing with fractional seconds
โข Variable substitution support
โข Non-blocking (script resumes after duration)
โข Useful for delays, throttling, and timing
Examples:
Basic Delays:
SLP 1 # Pause for 1 second
SLP 5 # Pause for 5 seconds
SLP 0.5 # Pause for 500 milliseconds
SLP 0.1 # Pause for 100 milliseconds
With Variables:
SET delay|2.5
SLP %delay% # Pause for 2.5 seconds
Rate Limiting:
FOR i|1|10
LOG Processing item %i%
# ... do work ...
SLP 0.5 # Wait 500ms between items
NXT
Countdown:
SET count|5
FOR i|5|1|-1
LOG Countdown: %i%
SLP 1
NXT
LOG Go!
Progressive Delays:
SET delay|0.1
FOR i|1|5
LOG Step %i%
SLP %delay%
SET delay|%delay%*2 # Double the delay each time
NXT
Practical Applications:
Polling Loop:
FOR i|1|60
# Check status
IFC %status%|==|ready
LOG Status is ready!
BRK
FIL
LOG Waiting... (%i%/60)
SLP 1 # Check every second
NXT
Throttled API Calls:
FOR file IN %file_list%
LOG Uploading %file%
# ... upload file ...
SLP 0.5 # Avoid rate limiting
NXT
User Interface Timing:
LOG Welcome to the system!
SLP 2
CLS
LOG Loading modules...
SLP 1
LOG Ready!
Retry with Backoff:
SET retry|0
LBL retry_start
# ... attempt operation ...
IFC %success%|!=|1
SET retry|%retry%+1
IFC %retry%|<|5
LOG Retry attempt %retry%
SLP %retry% # Wait 1s, 2s, 3s, 4s
GOT retry_start
FIL
FIL
Timing Examples:
SLP 0.001 # 1 millisecond
SLP 0.01 # 10 milliseconds
SLP 0.1 # 100 milliseconds
SLP 1 # 1 second
SLP 60 # 1 minute
SLP 3600 # 1 hour
Notes:
โข Accepts decimal values for sub-second precision
โข Minimum effective resolution depends on OS (usually 1-10ms)
โข Script is blocked during sleep (other tasks won't run)
โข For very long delays, consider using scheduler
โข Interrupted by Ctrl+C
โข Default is 1 second if no argument provided
๐ Usage:
SLP seconds
๐ก Examples:
SLP 1 # Pause for 1 second
SLP 5 # Pause for 5 seconds
SLP 0.5 # Pause for 500 milliseconds
SLP 0.1 # Pause for 100 milliseconds
SLP %delay% # Pause for 2.5 seconds
๐ Pro Tips:
Sleep time in milliseconds. Use for delays, rate limiting, or waiting for processes.
๐ Network & Communication
APT
Network & Communication
APT - Application Package Tool (๐ฆ)
Provides commands to install, remove, search, and show applications in the package system.
Usage:
APT INSTALL|AppName - Install an application
APT REMOVE|AppName - Remove an application
APT SEARCH|[pattern] - Search for applications (use | as wildcard for all)
APT SHOW|[pattern] - List installed apps (use | as wildcard for all)
Examples:
APT INSTALL|notepad
APT SEARCH| - Show all available apps in catalog
APT SHOW| - Show all installed apps
EXAMPLES:
APT install|notepad++ # Application package management commands.
APT search|browser
APT remove|old_app
APT show|
๐ Usage:
APT INSTALL|AppName - Install an application
๐ก Examples:
APT INSTALL|notepad
APT SEARCH| - Show all available apps in catalog
APT SHOW| - Show all installed apps
๐ Pro Tips:
Package manager for Fluxionix applications. Use "APT SEARCH|" to list all available apps.
DNL
Network & Communication
DNL - Download
Downloads a file from a specified URL with progress tracking and validation.
Usage:
DNL filename|url
DNL filename url\n\nEXAMPLES:\n DNL https://example.com/file.pdf|downloads\file.pdf # Download files from URLs with resume capability.\n DNL https://github.com/user/repo/archive/main.zip|temp\\n DNL %file_url%|%local_path% \n
๐ Usage:
DNL filename|url
๐ก Examples:
\n DNL https://example.com/file.pdf|downloads\file.pdf # Download files from URLs with resume capability.\n DNL https://github.com/user/repo/archive/main.zip|temp\\n DNL %file_url%|%local_path% \n
๐ Pro Tips:
Downloads with resume capability. Creates target directory if it doesn't exist.
SND
Network & Communication
SND - Send Email
Sends an email using SMTP with configuration from context. Supports attachments.
Usage:
SND variable|recipient|subject|message|[attachment]
EXAMPLES:
SND result|user@example.com|Test|Hello World
SND status|admin@company.com|Report|Daily backup completed
SND error|support@company.com|Error|System failure|error.log
๐ Usage:
SND variable|recipient|subject|message|[attachment]
๐ก Examples:
SND result|user@example.com|Test|Hello World
SND status|admin@company.com|Report|Daily backup completed
SND error|support@company.com|Error|System failure|error.log
๐ Pro Tips:
Check internet connectivity before running network commands
๐ Productivity
TOD
Productivity
TOD - ToDo Task Management
Advanced task management system with priorities, categories, due dates, and persistence.
Integrated with GUI for seamless task tracking and productivity management.
USAGE:
TOD # Show all tasks
TOD list # Show all tasks (detailed view)
TOD add||[description] # Add new task with optional description
TOD remove| # Remove task by name
TOD done| # Mark task as completed
TOD edit||done # Mark task as done
TOD edit||description| # Edit task description
TOD priority||<1-5> # Change task priority
TOD category|| # Change task category
TOD search| # Search tasks by keyword
TOD export|[filename] # Export tasks to file
TOD import|[filename] # Import tasks from file
TOD stats # Show productivity statistics
TOD clear # Clear all completed tasks
TOD purge # Clear all tasks (with confirmation)
PRIORITY LEVELS:
1 - ๐ด URGENT (Critical, immediate action required)
2 - ๐ HIGH (Important, high priority)
3 - ๐ก MEDIUM (Normal priority, default)
4 - ๐ข LOW (Low priority, when time permits)
5 - ๐ต SOMEDAY (Future consideration)
CATEGORIES:
work, personal, home, project, meeting, call, email, shopping, health, learning
FEATURES:
๐ท๏ธ Task categorization and tagging
๐
Due date tracking and reminders
โญ Priority-based task sorting
๐ Productivity statistics and analytics
๐พ Persistent storage across sessions
๐ Advanced search and filtering
๐ค Export/import functionality
โ
Completion tracking and history
๐ฏ Goal setting and progress tracking
๐ Notification system (GUI integration)
EXAMPLES:
TOD add|"Review quarterly reports"
TOD add|"Call client"|"About the new project timeline"
TOD add|"Buy groceries"|"Milk, bread, eggs"
TOD done|"Review quarterly reports"
TOD priority|"Call client"|2
TOD category|"Buy groceries"|personal
TOD edit|"Call client"|done
TOD edit|"Call client"|description|"Call client urgently"
TOD remove|"Buy groceries"
TOD search|project
TOD stats
TOD export|my_tasks.json
INTEGRATION:
โข Seamless GUI integration with real-time updates
โข Calendar integration for due date management
โข Email notifications for urgent tasks
โข Progress tracking and productivity analytics
โข Team collaboration features (future enhancement)
๐ Usage:
TOD
๐ก Examples:
TOD add|"Review quarterly reports"
TOD add|"Call client"|"About the new project timeline"
TOD add|"Buy groceries"|"Milk, bread, eggs"
TOD done|"Review quarterly reports"
TOD priority|"Call client"|2
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ String
CHR
String
CHR - Character from Code Point
Converts a numeric code point to a single character.
USAGE:
CHR codepoint
CHR target|codepoint
CHR codepoint|target
EXAMPLES:
CHR 157
CHR symbol|157
CHR 157|symbol
CHR letter|%num%
๐ Usage:
CHR codepoint
๐ก Examples:
CHR 157
CHR symbol|157
CHR 157|symbol
CHR letter|%num%
๐ Pro Tips:
Check the documentation for advanced usage patterns
ORD
String
ORD - Numeric Value from Character
Converts a single character to its numeric value.
For codepage-representable chars, CHR_CodePage mapping is used (default cp850).
USAGE:
ORD character
ORD target|character
EXAMPLES:
ORD ร
ORD code|ร
ORD code|%char%
LOG ord(ร)
๐ Usage:
ORD character
๐ก Examples:
ORD ร
ORD code|ร
ORD code|%char%
๐ Pro Tips:
Check the documentation for advanced usage patterns
๐ System
BMK
System
BMK - Advanced System Benchmark & Performance Analysis
Comprehensive benchmarking suite with strict performance criteria, bottleneck detection,
and detailed system analysis. Designed to identify performance issues and optimization opportunities.
USAGE:
BMK - Quick benchmark with overall score (2 minutes)
BMK BENCHMARK_TYPE - Run specific benchmark type
BENCHMARK TYPES:
quick, fast - Quick validation with overall score (2 minutes)
full, complete - Complete system analysis (10-15 minutes)
strict, enterprise - Enterprise-grade strict benchmarking
system, hardware - Hardware detection and analysis
memory, ram - Memory performance and latency tests
cpu, processor - CPU performance and multi-threading
disk, storage, io - Storage I/O performance (includes HDD detection)
network, net - Network performance and latency
stress, torture - Extreme stress testing (use carefully!)
bottleneck, analysis - Bottleneck detection and recommendations
STRICT PERFORMANCE RATINGS (Updated for Modern Systems):
S+ EXCEPTIONAL - Top-tier performance (95%+) - Flagship systems
S OUTSTANDING - Excellent performance (85%+) - High-end systems
A+ VERY GOOD - Strong performance (75%+) - Good gaming/work systems
A GOOD - Solid performance (65%+) - Mid-range systems
B+ AVERAGE - Acceptable performance (50%+) - Budget systems
B BELOW AVERAGE - Needs improvement (35%+) - Older systems
C+ POOR - Significant issues (25%+) - Very old hardware
C UNACCEPTABLE - Critical performance issues (<25%) - Replace needed
F FAILURE - System failure or critical bottlenecks
HDD PENALTY: Systems with HDDs automatically receive lower scores due to storage bottlenecks.
BOTTLENECK DETECTION:
๐ด Critical bottlenecks requiring immediate attention
๐ Major performance limitations
๐ก Minor optimization opportunities
๐ข Well-balanced system
OVERALL SYSTEM SCORE:
Weighted composite score considering all components
Identifies primary and secondary bottlenecks
Provides specific upgrade recommendations
Compares against modern system standards
EXAMPLES:
BMK # Quick benchmark with overall score
BMK full # Complete system analysis
BMK strict # Enterprise-grade benchmarking
BMK bottleneck # Bottleneck analysis only
BMK storage # Detect HDD vs SSD performance
FEATURES:
๐ Overall system score (0-100)
๐ฏ Bottleneck identification and ranking
๐ Performance trend analysis
๐ก Specific upgrade recommendations
โ ๏ธ HDD performance warnings
๐ Component-level analysis
๐ Detailed performance report
๐ Performance tier classification
๐ Usage:
BMK - Quick benchmark with overall score (2 minutes)
๐ก Examples:
BMK # Quick benchmark with overall score
BMK full # Complete system analysis
BMK strict # Enterprise-grade benchmarking
BMK bottleneck # Bottleneck analysis only
BMK storage # Detect HDD vs SSD performance
๐ Pro Tips:
Run benchmarks when system is idle for accurate results. Use "BMK strict" for enterprise evaluation.
HLP
System
HLP - Dynamic Help System
Advanced help system that automatically categorizes functions based on their CATEGORY
attribute and provides comprehensive documentation.
USAGE:
HLP - Show all functions organized by categories
HLP FUNCTION - Show detailed help for a specific function
HLP CATEGORY - Show functions in a specific category
DYNAMIC CATEGORIES:
The help system automatically discovers categories from function modules.
Common categories: system, files, variables, flow, input, network, advanced
EXAMPLES:
HLP # Show categorized function overview
HLP BMK # Show detailed help for BMK function
HLP system # Show all system functions
HLP files # Show all file operation functions
The help system automatically discovers all function modules, reads their CATEGORY
attribute, and displays comprehensive documentation with usage examples.
๐ Usage:
HLP - Show all functions organized by categories
๐ก Examples:
HLP # Show categorized function overview
HLP BMK # Show detailed help for BMK function
HLP system # Show all system functions
HLP files # Show all file operation functions
๐ Pro Tips:
Interactive help system. Use "HLP categories" to browse by category.
๐ System & Performance
AUT
System & Performance
AUT - Check admin status (๐)
Stores 'true' (if admin) or 'false' (if not admin) in the given variable.
Usage:
AUT variable_name
Example:
AUT isAdmin # Sets the variable isAdmin to 'true' or 'false'\n\nEXAMPLES:\n AUT isAdmin # Check admin/authentication status and store result in variable.\n AUT hasPermissions \n AUT adminStatus \n
๐ Usage:
AUT variable_name
๐ก Examples:
AUT isAdmin # Sets the variable isAdmin to 'true' or 'false'\n\nEXAMPLES:\n AUT isAdmin # Check admin/authentication status and store result in variable.\n AUT hasPermissions \n AUT adminStatus \n
๐ Pro Tips:
Some commands may require administrator privileges
PFM
System & Performance
PFM - Performance Monitor
Monitors system performance, including CPU, memory, disk usage, and top processes.
Usage:
PFM [INFO|PROCESSES]
๐ Usage:
PFM [INFO|PROCESSES]
๐ก Examples:
PFM example_parameter
๐ Pro Tips:
Some commands may require administrator privileges
SCH
System & Performance
SCH - Scheduler (โฐ)
With SCH you can schedule any interpreter command to run at a specific time.
You can add, remove, list, start, stop tasks and check the scheduler status.
Usage:
SCH ADD|name|time|command|[repeat]
SCH REMOVE|name
SCH LIST
SCH START
SCH STOP
SCH STATUS
Parameters:
name - Name of the task (freely chosen, must be unique)
time - Time (e.g. 23:00, 2025-07-25 18:00, +5m, +30s)
command - Interpreter command to execute (as in the console)
repeat -
For absolute times: ONCE (default), DAILY, HOURLY, WEEKLY
For relative times (+5m, +30s, +2h): ONCE (default), CONTINUOUSLY
Examples:
SCH ADD|backup|23:00|SAV ALL|DAILY
โ Executes SAV ALL every day at 23:00
SCH ADD|cleanup|+5m|FIL DEL|ONCE
โ Executes FIL DEL in 5 minutes
SCH ADD|mytask|+5m|FIL DEL|CONTINUOUSLY
โ Executes FIL DEL every 5 minutes, starting in 5 minutes
SCH REMOVE|backup
โ Removes the task 'backup'
SCH LIST
โ Shows all scheduled tasks
Note:
Scheduled tasks are saved automatically and reloaded on next start.
๐ Usage:
SCH ADD|name|time|command|[repeat]
๐ก Examples:
SCH ADD|backup|23:00|SAV ALL|DAILY
SCH ADD|cleanup|+5m|FIL DEL|ONCE
SCH ADD|mytask|+5m|FIL DEL|CONTINUOUSLY
SCH REMOVE|backup
SCH LIST
๐ Pro Tips:
Some commands may require administrator privileges
SST
System & Performance
SST - Service Status
Checks the status of a Windows service and stores the result in a variable.
Usage:
SST variable|service_name
๐ Usage:
SST variable|service_name
๐ก Examples:
SST example_parameter
๐ Pro Tips:
Some commands may require administrator privileges
TMR
System & Performance
TMR - Timer
Performs timer operations such as start, stop, elapsed, wait, schedule, and list. Duration can be in seconds or formatted (e.g., 1h30m45s).
Usage:
TMR action|[name]|[duration]|[command]
Actions: START, STOP, ELAPSED, WAIT, SCHEDULE, LIST
EXAMPLES:
TMR start|backup_timer
TMR wait|5
TMR schedule|reminder|1h30m|MSG Lunch break!
TMR stop|backup_timer
TMR list
๐ Usage:
TMR action|[name]|[duration]|[command]
๐ก Examples:
TMR start|backup_timer
TMR wait|5
TMR schedule|reminder|1h30m|MSG Lunch break!
TMR stop|backup_timer
TMR list
๐ Pro Tips:
Timer names are case-sensitive. Use descriptive names for multiple timers.
TON
System & Performance
TON - Task / Process Check
On Windows, lists running processes or stores whether a named process is
running. Process matching is case-insensitive and ignores a trailing `.exe`.
Usage:
TON
TON variable|process_name
Examples:
TON # Print the running process list
TON browser_running|chrome # Set %browser_running% to true or false
IFC %browser_running%|=|true::LOG Browser is running::END
๐ Usage:
TON
๐ก Examples:
TON # Print the running process list
TON browser_running|chrome # Set %browser_running% to true or false
๐ Pro Tips:
Some commands may require administrator privileges
๐ Utilities & Helpers
DAT
Utilities & Helpers
DAT - Date
Gets the current date and stores it in a variable. You can specify the date format.
USAGE:
DAT Variable|[Format]
DEFAULT FORMAT:
%d.%m.%Y
EXAMPLES:
DAT today|%d.%m.%Y # today = "16.08.2025"
DAT timestamp|%Y-%m-%d %H:%M:%S # timestamp = "2025-08-16 15:30:45"
DAT year|%Y # year = "2025"
DAT month|%m # month = "08"
DAT custom_date|%A, %B %d, %Y # custom_date = "Friday, August 16, 2025"
๐ Usage:
DAT Variable|[Format]
๐ก Examples:
DAT today|%d.%m.%Y # today = "16.08.2025"
DAT timestamp|%Y-%m-%d %H:%M:%S # timestamp = "2025-08-16 15:30:45"
DAT year|%Y # year = "2025"
DAT month|%m # month = "08"
DAT custom_date|%A, %B %d, %Y # custom_date = "Friday, August 16, 2025"
๐ Pro Tips:
Format codes: %d=day, %m=month, %Y=year, %H=hour, %M=minute, %S=second.
QUT
Utilities & Helpers
QUT - Quit
Shows a message in a GUI dialog with an OK button, then exits the interpreter.
Usage:
QUT [message]
๐ Usage:
QUT [message]
๐ก Examples:
QUT example_parameter
๐ Pro Tips:
Emergency exit with immediate termination. Use for critical error handling.
REM
Utilities & Helpers
REM - Remark
A comment line. No action is performed. Used for documentation in scripts.
Usage:
REM [comment]
EXAMPLES:
REM This is a comment
REM === Configuration Section ===
REM TODO: Add error handling
๐ Usage:
REM [comment]
๐ก Examples:
REM This is a comment
REM === Configuration Section ===
REM TODO: Add error handling
๐ Pro Tips:
Check the documentation for advanced usage patterns
TIM
Utilities & Helpers
TIM - Time
Gets the current time in a specified format and stores it in a variable.
USAGE:
TIM Variable|[Format]
DEFAULT FORMAT:
%H:%M:%S
EXAMPLES:
TIM current_time|%H:%M:%S # current_time = "15:30:45"
TIM hour|%H # hour = "15"
TIM minute|%M # minute = "30"
TIM full_timestamp|%Y-%m-%d_%H-%M-%S # full_timestamp = "2025-08-16_15-30-45"
๐ Usage:
TIM Variable|[Format]
๐ก Examples:
TIM current_time|%H:%M:%S # current_time = "15:30:45"
TIM hour|%H # hour = "15"
TIM minute|%M # minute = "30"
TIM full_timestamp|%Y-%m-%d_%H-%M-%S # full_timestamp = "2025-08-16_15-30-45"
๐ Pro Tips:
Same format codes as DAT. Useful for timestamps and time-based logic.
๐ Variables
SET
Variables
SET - Variable Assignment System
Intelligent variable assignment with automatic type detection, validation,
and support for complex data structures.
USAGE:
SET variable|value # Basic assignment
SET a[1]|foo # 1D array-like key assignment
SET a[x]|foo # Index variable resolution (if x exists)
SET matrix[x][y][z]|42 # Multi-dimensional array-like keys
SET variable value # Space-separated assignment
SET variable|%other_variable% # Variable reference assignment
SET variable|json:{"key":"value"} # JSON object assignment
SET variable|list:[1,2,3] # List assignment
SET variable|int:42 # Type-specific assignment
SET variable|float:3.14 # Float assignment
SET variable|bool:true # Boolean assignment
๐ฏ TYPE CASTING:
int:value - Convert to integer
float:value - Convert to floating point
bool:value - Convert to boolean (true/false, 1/0, yes/no)
str:value - Explicit string conversion
json:value - Parse as JSON object
list:value - Parse as list/array
auto:value - Automatic type detection
โก ADVANCED FEATURES:
โข ๐ Automatic type detection and conversion
โข ๐ Variable validation and error checking
โข ๐ Reference chaining (%var1% โ %var2% โ value)
โข ๐ JSON and list parsing with validation
โข ๐ฏ Math expression evaluation (SET result|calc:5+3*2)
โข ๐ Environment variable integration
โข ๐พ Persistent variable storage options
๐ EXAMPLES:
SET username|JohnDoe # Simple string
SET a[1]|1 # Array-like key
SET a[2]|2
FOR x|1|2::LOG %a[x]%::NXT x # Outputs 1 then 2
SET grid[1][2][3]|hello # Multi-dimensional access via %grid[i][j][k]%
SET age|int:25 # Integer with validation
SET config|json:{"debug":true} # JSON object
SET items|list:[apple,banana,cherry] # List of items
SET result|calc:10*5+2 # Math expression
SET flag|bool:yes # Boolean from yes/no
SET current_user|%USERNAME% # Environment variable
SET backup_user|%current_user% # Variable reference
๐ก PRO TIPS:
โข Variables are case-sensitive and persistent across sessions
โข Use descriptive names: user_count instead of uc
โข JSON objects support nested structures and arrays
โข Math expressions support +, -, *, /, %, ** (power), ()
โข Boolean values: true/false, yes/no, 1/0, on/off
โข Variable references support nested expansion: %outer_%inner%%
๐ง COMPATIBILITY:
โ
Enhanced type system with validation
โ
Cross-platform variable persistence
โ
Integration with all Fluxionix commands
๐ Usage:
SET variable|value
๐ก Examples:
SET username|JohnDoe # Simple string
SET a[1]|1 # Array-like key
SET a[2]|2
SET grid[1][2][3]|hello # Multi-dimensional access via %grid[i][j][k]%
SET age|int:25 # Integer with validation
๐ Pro Tips:
Use the pipe | separator. Variables support nested references.
๐ Variables & Data Processing
CAL
Variables & Data Processing
CAL - Calculator
Calculates one operation and stores the result as text.
Usage:
CAL result|value1|operator|value2
CAL variable|operator|value
Operators:
+, -, *, /, %, ^, **
Examples:
CAL result|10|+|5
CAL total|%price%|*|%quantity%
CAL counter|+|1
CAL power|2|^|8
๐ Usage:
CAL result|value1|operator|value2
๐ก Examples:
CAL result|10|+|5
CAL total|%price%|*|%quantity%
CAL counter|+|1
CAL power|2|^|8
๐ Pro Tips:
Supports basic arithmetic operators: +, -, *, /, %, **. Variables are auto-converted to numbers.
GET
Variables & Data Processing
GET - Command Execution & Output Capture
Intelligent command execution system with advanced output processing,
cross-platform compatibility, and comprehensive error handling.
USAGE:
GET variable|command # Execute command, store output in variable
GET variable|command|encoding # Specify custom encoding
GET variable|command|encoding|timeout # With timeout (seconds)
๐ฏ ADVANCED FEATURES:
โข ๐ Cross-platform command execution (Windows/Linux/macOS)
โข ๐ง Intelligent encoding detection (UTF-8, CP1252, system default)
โข โฑ๏ธ Configurable timeout protection
โข ๐ก๏ธ Comprehensive error handling and logging
โข ๐ Output processing and normalization
โข ๐จ ANSI color code stripping for clean output
โข ๐ Command validation and security checks
โข ๐ Execution history and performance tracking
โ๏ธ ENCODING OPTIONS:
utf-8 - Unicode UTF-8 (default, recommended)
cp1252 - Windows Western European
ascii - Basic ASCII
latin1 - Latin-1/ISO-8859-1
auto - Automatic detection
๐ EXAMPLES:
GET username|whoami # Get current username
GET disk_space|df -h # Get disk usage (Linux/macOS)
GET disk_space|dir C: /-c # Get directory info (Windows)
GET processes|ps aux # List processes (Linux/macOS)
GET processes|tasklist # List processes (Windows)
GET date_time|date # Current date/time
GET python_version|python --version # Python version
GET network_info|ipconfig /all # Network configuration (Windows)
GET network_info|ifconfig -a # Network configuration (Linux/macOS)
GET file_count|find . -type f | wc -l # Count files in directory
GET git_status|git status --porcelain # Git repository status
๐ฏ PLATFORM-SPECIFIC EXAMPLES:
Windows:
GET system_info|systeminfo
GET services|sc query state= all
GET installed_programs|wmic product get name
Linux/macOS:
GET memory_info|free -h
GET cpu_info|lscpu
GET process_tree|pstree
Cross-platform:
GET current_directory|pwd
GET environment|env
GET python_path|which python
๐ก PRO TIPS:
โข Commands run in the current working directory
โข Output is automatically trimmed of newlines and carriage returns
โข Use full paths for executables to avoid PATH issues
โข Combine with SET for variable processing: SET clean_output|%raw_output%
โข Chain commands with && or || for complex operations
โข Use timeout for potentially long-running commands
โข Escape special characters with quotes: GET output|"echo 'Hello World'"
๐ก๏ธ SECURITY FEATURES:
โข Command validation to prevent injection attacks
โข Timeout protection against hanging processes
โข Error logging for debugging and security auditing
โข Safe execution environment with limited privileges
โ ๏ธ IMPORTANT NOTES:
โข Commands execute with current user privileges
โข Network commands may require internet connectivity
โข Some system commands may need administrator/root privileges
โข Always validate command output before using in scripts
๐ Usage:
GET variable|command
๐ก Examples:
GET username|whoami # Get current username
GET disk_space|df -h # Get disk usage (Linux/macOS)
GET disk_space|dir C: /-c # Get directory info (Windows)
GET processes|ps aux # List processes (Linux/macOS)
GET processes|tasklist # List processes (Windows)
๐ Pro Tips:
Command output is automatically trimmed. Use single quotes around complex commands.
LEN
Variables & Data Processing
LEN - Length
Stores the character count of a variable's current value.
Usage:
LEN source_variable|target_variable
Examples:
LEN username|username_len
LEN message|message_length
๐ Usage:
LEN source_variable|target_variable
๐ก Examples:
LEN username|username_len
LEN message|message_length
๐ Pro Tips:
Returns character count for strings, item count for lists/arrays.
LOA
Variables & Data Processing
LOA - Load Variables
Loads variables written by SAV. The file uses Python pickle format.
Usage:
LOA filename
LOA filename|variable1,variable2,...
Examples:
LOA session.sav
LOA session.sav|username,score
๐ Usage:
LOA filename
๐ก Examples:
LOA session.sav
LOA session.sav|username,score
๐ Pro Tips:
Loads entire file content into variable. Use for small to medium files only.
RND
Variables & Data Processing
RND - Random Number Generator (๐ฒ)
Generates a random integer between specified minimum and maximum values (inclusive)
and stores the result in a variable.
Usage:
RND variable|min|max
Parameters:
variable - Variable name to store the random number
min - Minimum value (inclusive)
max - Maximum value (inclusive)
Features:
โข Cryptographically random (uses system random)
โข Inclusive range (both min and max can be generated)
โข Integer values only
โข Immediate variable assignment
Examples:
Dice Roll (1-6):
RND dice|1|6
LOG You rolled: %dice%
Coin Flip (0=Tails, 1=Heads):
RND coin|0|1
IFC %coin%|==|1
LOG Heads!
FIL
IFC %coin%|==|0
LOG Tails!
FIL
Lottery Number (1-49):
RND lotto1|1|49
RND lotto2|1|49
RND lotto3|1|49
LOG Your numbers: %lotto1%, %lotto2%, %lotto3%
Random Percentage (0-100):
RND chance|0|100
IFC %chance%|>|75
LOG Success! (>75%)
FIL
Random Delay (100-500ms):
RND delay|100|500
LOG Waiting %delay%ms...
SLP %delay%
Practical Applications:
Random Testing:
FOR i|1|10
RND test_value|1|100
LOG Test #%i%: %test_value%
NXT
Randomized Selection:
RND choice|1|3
IFC %choice%|==|1
LOG Selected Option A
FIL
IFC %choice%|==|2
LOG Selected Option B
FIL
IFC %choice%|==|3
LOG Selected Option C
FIL
Random Color (RGB):
RND red|0|255
RND green|0|255
RND blue|0|255
LOG Color: RGB(%red%, %green%, %blue%)
Simulation:
RND temperature|-10|35
RND humidity|20|90
LOG Weather: %temperature%ยฐC, %humidity%% humidity
Notes:
โข Both min and max are inclusive in the range
โข Min can be negative: RND temp|-20|40
โข Max must be >= Min
โข Result is always an integer
โข Each call produces a new random value
โข Uses high-quality random number generator
โข Variable is stored as string (use in comparisons/calculations)
๐ Usage:
RND variable|min|max
๐ก Examples:
RND dice|1|6
RND coin|0|1
RND lotto1|1|49
RND lotto2|1|49
RND lotto3|1|49
๐ Pro Tips:
Generates random integers. Use for dice, lottery numbers, or random selections.
RSV
Variables & Data Processing
RSV - Replace String in Variable (โ๏ธ)
Searches for a substring in a variable's value and replaces all occurrences with another string.
Search is case-insensitive by default, with optional case-sensitive mode.
Usage:
RSV variable|search|replace[|case]
Parameters:
variable - Name of variable to modify
search - Text to find (case-insensitive by default)
replace - Text to replace with
case - (Optional) Add 'case' for case-sensitive search
Features:
โข Case-insensitive search by default
โข Replaces ALL occurrences
โข Modifies variable in-place
โข Optional case-sensitive mode
โข Reports number of replacements
Examples:
Basic Replacement (case-insensitive):
SET greeting|Hello World, hello there
RSV greeting|hello|hi
LOG %greeting% # "hi World, hi there"
Case-Sensitive Mode:
SET text|Hello hello HELLO
RSV text|hello|hi|case
LOG %text% # "Hello hi HELLO" (only lowercase)
Remove Text:
SET path|C:\\Users\\Documents
RSV path|C:\\Users\\|
LOG %path% # "Documents"
Clean Whitespace:
SET data|value1 , value2 , value3
RSV data| |
LOG %data% # "value1,value2,value3"
Replace Special Characters:
SET filename|My File (copy).txt
RSV filename|(|_
RSV filename|)|_
RSV filename| |_
LOG %filename% # "My_File__copy_.txt"
Practical Applications:
Path Conversion:
SET path|C:\\Projects\\MyApp
RSV path|\\|/
LOG Unix path: %path% # "C:/Projects/MyApp"
Data Cleaning:
SET csv|name,age,city
RSV csv|,|;
LOG %csv% # "name;age;city"
Template Processing:
SET template|Dear {{NAME}}, welcome to {{COMPANY}}
RSV template|{{NAME}}|John
RSV template|{{COMPANY}}|TechCorp
LOG %template%
Normalize Input:
INP username|Enter username
RSV username| |
RSV username|-|_
LOG Normalized: %username%
Multiple Replacements:
SET url|https://example.com/path/to/file
RSV url|https://|http://
RSV url|example.com|newdomain.com
LOG %url% # "http://newdomain.com/path/to/file"
Notes:
โข Replaces ALL occurrences in the variable
โข Case-insensitive by default (use |case for case-sensitive)
โข Variable must exist or error is logged
โข Empty search string is not allowed
โข Empty replace string removes the search text
โข Original variable value is overwritten
โข For file content replacement, use RSF command instead
๐ Usage:
RSV variable|search|replace[|case]
๐ก Examples:
RSV greeting|hello|hi
RSV text|hello|hi|case
RSV path|C:\\Users\\|
RSV data| |
RSV filename|(|_
๐ Pro Tips:
Reserve variables before loops to restore original values later.
SAV
Variables & Data Processing
SAV - Save Variables
Writes selected variables, or all public context values, to a Python pickle file.
Usage:
SAV filename
SAV filename|variable1,variable2,...
Examples:
SAV session.sav
SAV session.sav|username,score,level
๐ Usage:
SAV filename
๐ก Examples:
SAV session.sav
SAV session.sav|username,score,level
๐ Pro Tips:
Automatically creates directory structure. Supports variable substitution in content.
SPL
Variables & Data Processing
SPL - Split String (๐ช)
Splits a variable's string value by a delimiter and extracts a specific part
by index, storing the result back in the same variable. It can also assign all
parts to multiple variables in one line.
Usage:
SPL variable|delimiter|index
SPL var1,var2,var3|sourcevar|delimiter
Parameters:
variable - Variable name to split and update
delimiter - Character(s) to split on
index - Zero-based index of part to keep
var1,... - Destination variables for all split parts
sourcevar - Variable containing the string to split
Features:
โข Zero-based indexing (0 = first part)
โข Modifies variable in-place
โข Any delimiter length supported
โข Automatic error handling
โข Empty result if index out of range
Examples:
Extract from CSV:
SET data|John,Doe,30,Engineer
SPL data|,|0
LOG First name: %data% # "John"
Assign all CSV fields:
SET source|Hallo,mein,Name
SPL var1,var2,var3|source|,
LOG %var1% %var2% %var3% # "Hallo mein Name"
SET data|John,Doe,30,Engineer
SPL data|,|3
LOG Profession: %data% # "Engineer"
Parse File Path:
SET path|C:\\Users\\John\\Documents\\file.txt
SPL path|\\|-1 # Get last part
LOG Filename: %path% # "file.txt"
Extract Email Domain:
SET email|user@example.com
SPL email|@|1
LOG Domain: %email% # "example.com"
Parse URL:
SET url|https://www.example.com/path/to/page
SPL url|/|2
LOG Hostname: %url% # "www.example.com"
Extract First Word:
SET sentence|Hello World from Fluxionix
SPL sentence| |0
LOG First word: %sentence% # "Hello"
Practical Applications:
Process CSV Line:
SET csv_line|Name,Age,City,Country
SET field|%csv_line%
SPL field|,|2
LOG City: %field% # "City"
Parse Version Number:
SET version|2.5.1
SET major|%version%
SPL major|.|0
LOG Major version: %major% # "2"
SET minor|%version%
SPL minor|.|1
LOG Minor version: %minor% # "5"
Extract File Extension:
SET filename|document.backup.txt
SPL filename|.|-1 # Last part
LOG Extension: %filename% # "txt"
Parse Log Entry:
SET log|2024-01-15 14:30:45 ERROR Database connection failed
SET time|%log%
SPL time| |1
LOG Time: %time% # "14:30:45"
SET level|%log%
SPL level| |2
LOG Level: %level% # "ERROR"
Multiple Splits:
SET data|user:password:role:department
SET username|%data%
SPL username|:|0
LOG User: %username% # "user"
SET role|%data%
SPL role|:|2
LOG Role: %role% # "role"
Error Handling:
SET value|a,b,c
SPL value|,|5 # Index out of range
LOG %value% # "" (empty)
Notes:
โข Index starts at 0 (first element)
โข Negative indices not supported (use positive from start)
โข Out of range index sets variable to empty string
โข Original variable value is overwritten
โข Delimiter can be multiple characters: SPL data|:::|1
โข Empty delimiter not supported
โข For keeping all parts, consider alternative approaches
โข Variable must exist or error is logged
๐ Usage:
SPL variable|delimiter|index
๐ก Examples:
SPL data|,|0
๐ Pro Tips:
Variable names are case-sensitive and support context inheritance