Troubleshooting Guide

This guide provides solutions to common issues you might encounter while using the ARX CLI. If you’re experiencing problems with any of the following commands, refer to the corresponding section for troubleshooting steps.

Table of Contents

• arx login
• arx preview:endpoint
• arx preview:hbs
• arx migrate
• arx benchmark:endpoint
• arx generate:test
• arx run:test

arx login

Errors:

1. Authentication Failed

   Error message: Authentication failed: Invalid credentials

   Solution:

   • Double-check your username and password
   • Ensure you have an active Login session
   • Try resetting your password

2. Network Connection Issues

   Error message: Unable to connect to authentication server

   Solution:

   • Check your internet connection
   • Verify that the community authentication server is not down
   • Try using a different network if

arx preview:endpoint

Errors:

1. Endpoint Not Found

   Error message: Error: Endpoint not found

   Solution:

   • Verify that the endpoint path is correct
   • Ensure the endpoint file exists in your project
   • Check for typos in the endpoint name

2. Port Already in Use

   Error message: Error: Port 3000 is already in use

   Solution:

   • Stop any other services using the same port
   • Use a different port by specifying it in the command: arx preview:endpoint --port 3001

arx preview:hbs

Errors:

1. Template Not Found

   Error message: Error: Cannot find template file

   Solution:

   • Ensure the Handlebars template file exists in your project
   • Check the file path and name for any typos
   • Verify that you’re in the correct project directory

2. Invalid Handlebars Syntax

   Error message: Error: Invalid Handlebars syntax in template

   Solution:

   • Review your Handlebars template for syntax errors
   • Ensure all opening tags have corresponding closing tags
   • Check for proper helper usage and parameter passing

arx migrate

Errors:

1. Migration Failed

   Error message: Error: Migration failed - Database connection error

   Solution:

   • Verify your database connection settings
   • Ensure the database server is running and accessible
   • Check for any network issues that might prevent connection

2. Conflicting Migrations

   Error message: Error: Conflicting migration found

   Solution:

   • Review your migration files for any conflicts
   • Ensure migration file names are unique and in the correct order
   • Manually resolve conflicts if necessary

arx benchmark:endpoint

Errors:

1. Endpoint Timeout

   Error message: Error: Endpoint timed out during benchmark

   Solution:

   • Check the endpoint’s performance and optimize if
   • Increase the timeout limit in the benchmark settings
   • Verify that the endpoint server is not overloaded

2. Invalid Benchmark Configuration

   Error message: Error: Invalid benchmark configuration

   Solution:

   • Review your benchmark configuration file
   • Ensure all required parameters are set correctly
   • Check for any syntax errors in the configuration

arx generate:test

Errors:

1. Invalid Test Template

   Error message: Error: Invalid test template specified

   Solution:

   • Verify that the test template exists and is correctly named
   • Ensure you’re using a supported test template
   • Check for any typos in the template name

2. Insufficient Permissions

   Error message: Error: Permission denied when creating test file

   Solution:

   • Ensure you have write permissions in the project directory
   • Run the command with elevated privileges if necessary
   • Check file system permissions for the project folder

arx run:test

Errors:

1. Test Framework Not Found

   Error message: Error: Test framework not found

   Solution:

   • Ensure the required test framework is installed
   • Verify that the test framework is properly configured in your project
   • Check your project’s dependencies and install any missing packages

2. Test Execution Failed

   Error message: Error: Test execution failed - Assertion error

   Solution:

   • Review the failing test and the associated code
   • Check for any recent changes that might have broken the test
   • Ensure all dependencies required for the test are available and up-to-date

If you encounter any errors not listed here or if the provided solutions don’t resolve your issue, please be sure to reach out to AI team for further assistance.