Overview
Complete guide to using the RadishKit CLI for script testing, deployment, and management
The RadishKit CLI is a command-line tool that enables you to test, execute, and manage Accela EMSE scripts locally. This guide covers all CLI features, commands, and best practices.
What is the RadishKit CLI?
The RadishKit CLI provides:
- Script Testing: Test scripts safely with automatic rollback
- Parameter Management: Save and reuse script parameters
- Event Handling: Execute event scripts (ASA, WTUA, IRSA)
- Batch Processing: Run batch scripts with parameters
- SQL Queries: Execute SQL queries against your Accela database
- Safe Testing: Scripts run but changes are automatically rolled back in test mode
- Multiple Script Types: Solution scripts, event scripts, batch scripts, and SQL queries
- Parameter Persistence: Automatically saves parameters for reuse across sessions
Authentication with RadishKit
First, authenticate with RadishKit and check your connection:
# Login to RadishKit accli login # Check your authentication status accli status
Initializing a Project
Each project/repository needs to be initialized and linked to an Accela environment. You can easily change the agency and environment you're linked to:
# Initialize a new project accli init # Link to an agency environment accli link
Executing a Generic Script Test
Start with a simple script test without parameters to see the CLI in action:
# Test a script (rollback mode - safe testing) accli test script Scripts/MyScript.js
The CLI will show script execution output, debug messages, and any errors directly in your terminal.
Execute a Script Test Using Parameters
Interactive Mode
When you run a script without parameters, the CLI will ask:
- Run without parameters? - Execute the script as-is
- Use existing parameter set? - Select from saved parameters
- Create new parameter set? - Enter new parameters interactively
Interactive mode creates reusable parameter sets that are saved in RadishKit for future use.
Non-Interactive Mode
For automation and scripting, use the --param
flag:
# Test with parameters (not saved) accli test script Scripts/MyScript.js \ --param "recordId=PR2024-001" \ --param "status=Complete" \ --param "department=Building"
Viewing Script Execution Logs in RadishKit
After running scripts, you can view detailed execution logs, performance metrics, and debugging information in the RadishKit web interface. This provides a comprehensive view of your script execution history and helps with troubleshooting.
VS Code/Cursor Add-ons
VSCode/Cursor Extension
Use the RadishKit VSCode/Cursor extension for execution context menus and enhanced development experience.
Installation:
# Install VSCode/Cursor extension and Cursor rules accli install-tools
Usage:
- Right-click on script files to access execution context menus
Installing Cursor Rules
Install Cursor rules for better AI assistance when working with Accela scripts.
Installation:
# Install Cursor rules via CLI accli install-tools
Checking for CLI Updates
# Check for CLI updates accli update # Install development tools accli install-tools
Common Issues
- Authentication errors: Run
accli login -r
for a quick refresh of your RadishKit authentication token - Connection issues: Run
accli status
to check your setup - Script errors: Check execution logs in the RadishKit web interface
Next Steps
Ready to dive deeper? Explore these essential topics:
- Parameter Management - Master parameter handling and reuse
- Testing a Record Script - Test solution scripts safely
- Testing an Event Script - Handle Accela events (ASA, WTUA, IRSA)
- Testing a Batch Script - Process batch scripts with parameters
- Executing a SQL Query - Execute database queries directly