# How to debug Toolkit Apps not loading, showing up, missing in the Menus, Shotgun Desktop or the AMIs

**URL:** <https://community.shotgridsoftware.com/t/how-to-debug-toolkit-apps-not-loading-showing-up-missing-in-the-menus-shotgun-desktop-or-the-amis/6739>\
**Category:** Pipeline Integrations\
**Tags:** fptr-tk, debug\
**Created:** [August 28, 2018, 1:45pm UTC](https://community.shotgridsoftware.com/t/how-to-debug-toolkit-apps-not-loading-showing-up-missing-in-the-menus-shotgun-desktop-or-the-amis/6739 "2018-08-28T13:45:49Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![philip.scadding](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/philip.scadding/32/30_2.png) [@philip.scadding](https://community.shotgridsoftware.com/u/philip.scadding)\
**Post date:** [August 28, 2018, 1:45pm UTC](https://community.shotgridsoftware.com/t/how-to-debug-toolkit-apps-not-loading-showing-up-missing-in-the-menus-shotgun-desktop-or-the-amis/6739/1 "2018-08-28T13:45:49Z")

</div>

Something that comes up from time to time is the issue of figuring out why a given app is not showing.  
You may have created a custom app that is not showing, or simply one of the apps wee provide is not showing in the following:

- In the Shotgun menu in a DCC
- Shotgun Desktop
- In the Browser Toolkit action menu items.

There could be a number of reasons. The most likely being that there is a problem with the way you have configured the environment yml files, or that there is a bug with the App its self.

Start by looking at the config, and make sure you have added the app to the correct environment and engine.

Then make sure you’ve enabled [debug](https://developer.shotgunsoftware.com/143e0a94/), reproduce the issue and then look at your [logs](https://developer.shotgunsoftware.com/38c5c024/); depending on what you find in the logs here are some common causes:

1. You’ve left off the `location` settings on the app definition inside the environment ymls. All apps must define a valid location. For example, [here](https://github.com/shotgunsoftware/tk-config-default2/tree/v1.3.1/env/includes/settings/tk-multi-loader2.yml#L43) is the location settings for the loader2 app, although they’ve actually been separated off into a separate file [here](https://github.com/shotgunsoftware/tk-config-default2/tree/v1.3.1/env/includes/app_locations.yml#L47-L50). In this situation you will likely have an error like this:

2. Perhaps there is a syntax error somewhere in the config’s env YAMLs. In this situation, there should be an error in the logs pointing to the location of the syntax issue in the config YAML.

3. Perhaps the app encountered an error registering its self. In which case you should search the logs for the following: `failed to initialize. It will not be loaded.` and there should be an error that explains why.

4. The app may not be configured correctly in which case the log may contain a line similar to the one below. The key thing here is search for `It will not be loaded` and it should give a reason as to why its not been loaded. In this case, our app configuration points to a template that doesn’t exist in the `templates.yml`.

**Tip:**

If you’re having issues debugging a custom app, it’s best to start by adding it to the `tk-shell` engine and then launching it through the command line using `tank`. Ie. if you added your app to the `tk-shell` engine in `shot_step.yml` environment then you would launch it from `tank` with something like `tank Task 1234 launch_my_app` (where 1234 is the ID of the `Task` on the `Shot`). If you’re not sure on the command for launching your app you can run `tank Task 1234` and it will list out all available app command, as well as any errors it had registering apps.

---

<div class="post-metadata">

**Author:** ![philip.scadding](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/philip.scadding/32/30_2.png) [@philip.scadding](https://community.shotgridsoftware.com/u/philip.scadding)\
**Post date:** [February 21, 2020, 4:01pm UTC](https://community.shotgridsoftware.com/t/how-to-debug-toolkit-apps-not-loading-showing-up-missing-in-the-menus-shotgun-desktop-or-the-amis/6739/3 "2020-02-21T16:01:00Z")

</div>

Bumping this, as it was an old internal post which I’m sharing publicly.
