IBM Cloud Docs
Debugging

Debugging

Debug an issue when you experience it.

There might be a configuration issue with the taxonomy or a CLI version issue.

Try one of the following options to resolve the issue.

Validating the local taxonomy

  1. Install the ilab CLI.

  2. Run the ilab command to verify that the CLI is installed.

    ilab
    

    Output:

    Usage: ilab [OPTIONS] COMMAND [ARGS]...
    
       CLI for interacting with InstructLab.
       ...
    
  3. Initialize the ilab CLI and complete the prompts.

    ilab init
    
  4. Run the diff command where the --taxonomy-base is the branch to compare the local files with. If you are using the InstructLab community taxonomy, this branch is main.

    ilab taxonomy diff --taxonomy-path <local-path-to-taxonomy>  --taxonomy-base empty
    

    Output:

    Taxonomy in <local-path-to-taxonomy> is valid :)
    

Verifying the version

If the issues are with the backend and not your taxonomy or local configuration, verify that the local CLI installation version matches what is being used in the backend.

  1. Get the back end instructlab version.

    a. In the COS bucket, click synthetic_data > ID > logs > ilab_system_info.log.

    b. Click Download object to download the log file.

    c. Note the value for instructlab.version.

  2. Get the local CLI version.

    ibmcloud ilab -v
    
  3. If the versions do not match, update the local CLI plugin.

    ibmcloud plugin update ilab