CLI Commands Reference
Complete reference for all RadishKit CLI commands including script testing, deployment, and management
This comprehensive reference covers all available RadishKit CLI commands for testing scripts, managing projects, and working with your Accela environments.
Authentication Commands
accli login
Authenticate with RadishKit.
accli login
What it does:
- Prompts for email and password
- Stores authentication token locally
- Verifies connection to RadishKit
Example:
$ accli login Email: user@example.com Password: ******** ✓ Successfully authenticated with RadishKit
accli logout
Log out from RadishKit.
accli logout
What it does:
- Removes stored authentication token
- Clears local credentials
- Requires re-authentication for future commands
accli status
Display current authentication and environment status.
accli status
What it shows:
- Authenticated user information
- Linked agency and environment
- Connection status
- CLI version
Example output:
✓ Authenticated as: user@example.com ✓ Agency: springfield-city ✓ Environment: production ✓ Connection: Active ✓ CLI Version: 1.2.3
Project Management Commands
accli init
Initialize a new project with RadishKit CLI configuration.
accli init
What it creates:
.accela-cli/
directory- Configuration files
- VS Code integration (optional)
- Project structure
accli link
Link project to an agency environment.
accli link
Interactive prompts:
- Select agency from available agencies
- Select environment from available environments
- Confirm configuration
- Create local config file
Example:
$ accli link Available agencies: 1. Springfield City (springfield-city) 2. Metro County (metro-county) Select agency: 1 Available environments: 1. Civcon (dev) 2. Testing (test) Select environment: 2 ✓ Linked to Springfield City - Testing environment
accli config show
Display current configuration.
accli config show
Shows:
- Agency information
- Environment details
- Project settings
- Authentication status
Script Testing Commands
accli test script
Execute a generic/on-demand script in rollback mode (safe testing).
# Basic usage accli test script Scripts/MyScript.js # With parameters accli test script Scripts/MyScript.js --param "recordId=PR2024-001" --param "status=Complete" # With commit (applies changes to database) accli test script Scripts/MyScript.js --commit # Don't save to script library accli test script Scripts/MyScript.js --no-save
Options:
--commit
- Commit changes instead of rolling back--param key=value
- Set script parameters (repeatable)--no-save
- Don't save script to RadishKit library--record <id>
- Set record context (e.g., "PR2024-001")
Interactive Parameter Mode: When you run 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
accli test event
Execute an event script (ASA, WTUA, IRSA, etc.).
# ASA (ApplicationSubmitAfter) accli test event asa Scripts/Event/ASA_Handler.js --record "PR2024-001" # WTUA (WorkflowTaskUpdateAfter) accli test event wtua Scripts/Event/WTUA_Handler.js \ --record "PR2024-001" \ --task "Review" \ --status "Complete" # IRSA (InspectionResultSubmitAfter) accli test event irsa Scripts/Event/IRSA_Handler.js \ --record "PR2024-001" \ --inspection "Electrical"
Event-specific options:
--record <id>
- Required: Record ID (e.g., permit, license number)--task <name>
- For WTUA: workflow task name--status <status>
- For WTUA: task status--inspection <type>
- For IRSA: inspection type
accli test batch
Execute a batch script.
# Basic batch script accli test batch Scripts/Batch/DailyReport.js # With parameters accli test batch Scripts/Batch/DailyReport.js \ --param "StartDate=2024-01-01" \ --param "EndDate=2024-01-31" \ --param "Department=Building" # With commit accli test batch Scripts/Batch/DailyReport.js --commit
Options:
--param key=value
- Set batch parameters (repeatable)--commit
- Commit changes (batch scripts typically need this)
accli test sql
Execute a SQL query file (SELECT queries only).
# Basic query (auto-limited to TOP 1000) accli test sql queries/MyQuery.sql # Remove TOP 1000 limit (use with caution) accli test sql queries/MyQuery.sql --no-limit
Options:
--no-limit
- Remove the automatic TOP 1000 safety limit
Safety Note: SQL queries default to TOP 1000 limit to prevent accidental large data pulls.
Commit Execution Commands
accli run script|event|batch
Shortcut for test --commit
. Use for commit executions.
# Run script with commit accli run script Scripts/MyScript.js # Run batch script accli run batch Scripts/Batch/DailyReport.js --param "Date=2024-01-15" # Run event script accli run event asa Scripts/Event/ASA_Handler.js --record "PR2024-001"
Warning: run
commands commit changes to your database. Always test with accli test
first!
Utility Commands
accli hello
Test connectivity with a simple "hello world" script.
accli hello
What it does:
- Runs a simple test script
- Verifies end-to-end connectivity
- Checks authentication and environment connection
accli update
Check for CLI updates.
accli update
What it does:
- Checks npm registry for newer versions
- Compares with current version
- Prompts to upgrade if available
accli install-tools
Install additional development tools.
# Install all tools accli install-tools # Interactive installation accli install-tools --interactive
What it installs:
- VS Code/Cursor extension
- Cursor AI rules
- Development guides
- Project templates
Parameter Management
How Parameter Persistence Works
- When you run a script with
--param
options, the CLI saves them - Next time you run the same script, the CLI:
- Pre-fills saved parameters
- Prompts for any missing parameters
- Lets you override parameters with new
--param
values
Interactive Parameter 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
Non-Interactive Mode
For automation and scripting, use the --param
flag:
accli test script Scripts/MyScript.js \ --param "recordId=PR2024-001" \ --param "status=Complete" \ --param "department=Building"
Example Workflow
First execution:
accli test batch Scripts/Batch/Report.js \ --param "StartDate=2024-01-01" \ --param "EndDate=2024-01-31"
Parameters are saved. Next execution:
# CLI remembers previous parameters accli test batch Scripts/Batch/Report.js # Or override specific parameters accli test batch Scripts/Batch/Report.js --param "EndDate=2024-02-29"
Viewing Saved Parameters
Saved parameters are stored in:
.accela-cli/saved-params/<script-name>.json
Getting Help
Command Help
# Get help for a specific command accli <command> --help # Get help for all commands accli --help
Common Issues
Authentication errors:
- Run
accli logout
thenaccli login
- Check your email and password
- Verify your RadishKit account is active
Connection issues:
- Run
accli status
to check your setup - Verify your environment is properly configured
- Check that the wrapper script is installed in Accela
Script execution errors:
- Ensure the wrapper script is installed in Accela
- Check that the script name is exactly
RADISH_ACCELA_CLI
- Verify your Accela user has script execution permissions