Context Sensitive Help

CLI Context-Sensitive Help

 

Introduction

Catalyst provides context-sensitive help when you encounter an error during a CLI command execution. For example, if there is an unexpected error in the usage of a command or while fetching a resource during a command execution, Catalyst will provide you help for the particular context of the error.

Contextual help involves understanding the purpose or usage of a command by the user, and the reason for the error occurrence. Catalyst will analyze the situation dynamically to learn the reason behind not obtaining the expected result, and provide you customized help accordingly.

When you run into an unexpected error during a command execution, Catalyst will not only specify the reason behind the error, but it will also provide you help with the actions you can take to rectify or prevent the error. Catalyst will also display a help link to the documentation of the particular command or action. You can simply open the help link URL in a browser and access the help documentation.

Here are some examples of the CLI contextual help:

  • If you execute the catalyst client:delete [options] [client_version] command to delete a live version of the client, the CLI will inform you that a currently live client cannot be deleted. It will also suggest that you could make a different version live or deploy a new version of the client before attempting the deletion operation again. It will also provide you a help link to the specific section in the CLI documentation that contains a detailed explanation.
  • If you execute a CLI command while being logged out from your Catalyst remote account, the CLI will inform you that it was unable to authenticate your command execution. It will suggest that you log in to your account or execute the command with a valid auth token, and provide a help link.
  • If you deploy a resource with a required configuration file missing, the CLI will inform you about the particular absent file and suggest you to include it in the directory. You can learn about the project directory structure from the help link provided, and rectify the errors.
 

List of Possible Errors in Command Executions

Here are some common possible errors that you could encounter in your CLI during command executions, and the actions you can take to resolve them:

Command/ComponentErrorsFixes
AuthenticationEmpty Token BasketGenerate a new token
Token Retrieval FailureUse a valid token from the list
Logged out of CLILog in to the CLI
Refresh Token or Access Token Retrieval FailureLog in to the CLI using --no-localhost
Token Generation FailureGenerate a new token
Invalid Token Provided with --token optionProvide a valid token with the option
Authentication FailureRe-login with the --force option
Data CenterInvalid Input for the --dc OptionSpecify a valid input and try again
ProjectFirst Catalyst Project Not CreatedCreate a new project
Project Provided with -p option Not FoundSelect an existing project from the list
File Missing in Project DirectoryInitialize the project or set up the missing component
Resource Not Found in Project DirectoryInitialize the project or set up the missing component
Project Not Found in the Remote ConsoleUse an available project from the list
File Corrupted in Project DirectoryDelete the corrupted file and initialize the project again
Active Project Not Found in the Remote ConsoleChange the existing active project to an available one
API GatewayEnable APIG Failure- APIG Scheduler in ProgressCheck the status of the scheduled job and try again after some time
APIG Reports Not FoundDeploy APIG rules from the CLI
Disable APIG Failure- APIG Scheduler in ProgressCheck the status of the scheduled job and try again after some time
Unable to Read APIG Rules FileRectify the specified errors and try again
APIG Rules File MissingCreate the missing file or specify a valid file name
Name Missing in APIG RuleProvide a name for the APIG rule
Duplicate APIG Rule NameChange the name or delete the APIG rule
Mandatory Values Missing in APIG RuleAdd the specified mandatory values to the APIG rule
Duplicate Values in APIG RuleModify the APIG rule and resolve the conflict
Invalid Client Specified in APIG RuleRectify the specified errors in the client and try again
Cannot Authenticate APIG Rule with Client TargetRemove the specified key from the APIG rule
Invalid RegEx in APIG RuleRectify the specified RegEx error
Invalid Parameters in APIG RuleRectify the specified error to continue
Invalid Request or Target URL in APIG RuleProvide a valid target URL in the APIG rule
Data StoreTable Identifier Missing in Export/Import OperationProvide the table identifier in the command or configuration file
Source File Missing in Import OperationProvide the path of the CSV file in the local machine with the command, or the File ID of the file uploaded in File Store in the config JSON
No Folders Present in File Store to Upload CSV File for ImportCreate atleast one folder in the File Store
ClientWeb Client Not Found in the Local MachineCreate a new web clien
Web Client Not Found in the Remote ConsoleDeploy a web client from the CLI
Web Client Version Not Found in Local Machine/Remote Console to DeleteDelete a version from the list of versions available
Web Client Version is Live and Cannot be DeletedChange the live version to a different one or deploy a new version of the web client
Cannot Use --local and --remote Options Simultaneously to DeleteUse either one of the options at a time
Client File Cannot be ParsedRectify the specified error and try again
File Missing in Client DirectoryCreate the specified file in the client source directory
File Corrupted in Client DirectoryRectify the specified error or provide valid targets
FunctionsNo Functions in the Remote Console to Configure or Use Feature forCreate a new function in the console or deploy a function to the console
Invalid Value with --memory Option while ConfiguringProvide a valid number with the option
Function Not Found in the Local Machine to DeleteSelect an available function from the list to delete
No Functions in the Local Machine to DeleteCreate a new function in the project directory
Function Not Found in the Remote Console to DeleteSelect an available function from the list to delete
No Functions in the Remote Console to DeleteCreate a new function in the console or deploy a function to the console
Cannot Use Function ID in the Local Machine to DeleteUse the function name or execute the command without specifying any function identifiers
Cannot Use --local and --remote Options Simultaneously to DeleteUse either one of the options at a time
Configuration FilesFunctions Specified in Config File Not FoundSpecify valid function names under the functions key
Client Specified in Config File Not FoundSpecify a valid client source directory under the client key
Directory Specified in Config File Not FoundSpecify a valid directory name that is available in the project directory
Invalid Targets in Config FileSpecify valid values as targets in the config file
File Missing in Project Root DirectoryInitialize the project again
ScriptsInvalid Script CommandSpecify the command in a valid format
Invalid Feature SpecifiedSpecify a valid feature to execute the script
Script Unavailable in FileRun an available script
Script Exited with ErrorRectify the error and try again
Event GenerateOptions Provided Not in PairsProvide the options as pairs in the right format
Source InvalidProvide an available source
Options in Invalid FormatProvide the options in a valid format
Event Bus Name Missing in Custom EventProvide the Event Bus name
Rule Identifier Missing in Custom EventProvide the Rule Identifier
Event Bus Not Found in the Remote ConsoleProvide an available Event Bus name
Action Not Compatible with SourceProvide an action compatible with the source
Incorrect Segment/Table/Folder IdentifierProvide a valid identifier with the option
Event Generate: Integration FunctionsIncorrect Input Value for Cliq Integration EventProvide the input in the right format
Unknown Combination of Cliq ComponentChoose the appropriate combination of Cliq components from the list
Integration Service UnavailableProvide an available integration service
PullInvalid Value with CommandProvide the values client, functions, or apig with the command
ServeNo Valid Components to ServeRectify the errors and try again
Ports in the Given Range UnavailableSpecify a port out of the given range
ShellNo Valid Functions to ServeRectify the errors and try again
DeployNo Functions Ready for DeployExecute the deploy command with an appropriate option
APIG Deploy SkippedEnable API Gateway locally and deploy it once again
Java Functions ConfigurationJAR File Missing in the Path Specified in Config FileSpecify a valid path to the JAR file
File Corrupted in Function DirectoryDelete the corrupted file and execute the command again
Project Name Mismatch in Config FileChange the project name to an appropriate value
Java Compiler Version Check FailureEnsure that Java Compiler is installed and execute the command again
Java Compiler Above Compatible VersionDowngrade Java Compiler to a supported version
Main File Missing in Function DirectorySpecify a valid main file in the config file
Java Compilation ErrorRectify the specified errors to continue
Node.js Functions ConfigurationMain File Missing in Function DirectorySpecify a valid main file in the config file
Options UsageDuplicate Targets Specified for OptionRemove the duplicate value and try again
Invalid Target Specified with OptionProvide a valid target as specified
Target Specified With and Without FilterProvide the target in a valid format
Unable to Debug Client TargetRemove the client as a target in --debug and try again
Conflict in Option UsageUse only one of the options at a time
Invalid Input for OptionProvided a valid input as specified and try again
APIG Cannot Be Served SeparatelyInclude atleast one other component like functions or client
GeneralNot in Catalyst App Directory during Command ExecutionRun the command from a valid Catalyst directory or initialize a project to make this a Catalyst app directory
Incorrect Usage of CommandUse catalyst help or execute the command with the --help option to get usage instructions
Unable to Load FileRectify the specified errors to continue
Requested Port UnavailableProvide a different port with the command

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocatalyst.com