The RadishKit CLI is a powerful command-line tool that allows you to test and execute Accela scripts locally. This guide will walk you through installation and initial setup.

Prerequisites

Before installing the CLI, ensure you have:

• Node.js (version 16 or higher)
• npm or yarn package manager
• Access to your Accela environment (credentials configured in RadishKit)
• RadishKit account with an agency and environment set up

Installation Methods

Method 1: Global Installation (Recommended)

Install the CLI globally for system-wide access:

npm install -g @radishkit/accli

Method 2: Local Installation

Install the CLI locally in your project:

npm install @radishkit/accli

Method 3: Using npx (No Installation)

Run the CLI without installing:

npx @radishkit/accli <command>

Verify Installation

After installation, verify the CLI is working:

accli --version

You should see the current version number. If you get a "command not found" error, ensure the CLI is in your PATH.

Initial Setup

Step 1: Authenticate with RadishKit

accli login

This will prompt you for:

• Email: Your RadishKit account email
• Password: Your RadishKit account password

The CLI will store your authentication token locally for future use.

Step 2: Link to Your Agency Environment

Prerequisites: Your agency and environment must be configured in RadishKit before linking.

accli link

This interactive command will:

1. Show available agencies (that are configured in RadishKit)
2. Let you select your agency
3. Show available environments
4. Let you select your environment
5. Create a local configuration file

Step 3: Test Your Connection

accli hello

This command runs a simple "hello world" script to verify:

• Authentication is working
• Environment connection is established
• Script execution is functional

Project Structure

After linking, the CLI creates a .accela-cli directory for your project:

your-project/
├── .accela-cli/
│   ├── config.json          # Agency configuration
│   ├── extension/           # VSCode/Cursor extension files
│   └── wrapper/             # CLI wrapper files

Configuration File

.accela-cli/config.json

This file contains your project configuration:

{
  "agency": "your-agency-slug",
  "environment": "your-environment-id",
  "projectName": "Your Project Name"
}

Basic Usage

Test a Script

# Test a solution script
accli test script Scripts/MyScript.js

Test an Event Script

# Test an ASA event
accli test event asa Scripts/Event/ASA_Handler.js 

# Test a WTUA event
accli test event wtua Scripts/Event/WTUA_Handler.js 

Test a Batch Script

accli test batch Scripts/Batch/DailyReport.js 

Parameter Management

The CLI automatically saves parameters for scripts, making it easy to re-run scripts with the same parameters.

Interactive Mode

1. When you run a script you will be prompted to execute it with parameters or not.
2. If you choose to execute with parameters, you will be prompted to enter the parameters.
3. The parameters will be saved and used for future executions.

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"

Common Commands

Authentication

accli login          # Authenticate with RadishKit
accli logout         # Log out
accli status         # Check authentication status

Script Testing

accli test script <file>     # Test a solution script
accli test event <type> <file>  # Test an event script
accli test batch <file>     # Test a batch script
accli test sql <file>       # Test a SQL query

Project Management

accli init           # Initialize a new project
accli link           # Link to an agency environment
accli config show    # Show current configuration

Utilities

accli hello          # Test connectivity
accli update         # Check for updates
accli install-tools  # Install VS Code extension

Troubleshooting

Common Issues

"Command not found" error:

• Ensure the CLI is installed globally: npm install -g @radishkit/accli
• Check your PATH environment variable
• Try using npx @radishkit/accli instead

Authentication errors:

• Run accli logout then accli login again
• Check your email and password
• Verify your RadishKit account is active

Environment connection issues:

• Run accli link to reconfigure your environment
• Check that your Accela credentials are correct
• Verify 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

Getting Help

For CLI issues:

• Run accli <command> --help for command-specific help
• Check execution logs in the RadishKit web interface
• Contact support at aaron@radishapps.com

Next Steps

Now that the CLI is installed:

1. Install VS Code Extension - Enhance your development experience
2. Execute Your First Script - Test your setup
3. Learn CLI Commands - Master the CLI

Ready to install the VS Code extension? Continue to Install VS Code Extension!