| name | avo-menu-icons |
| description | Add icons to Avo menu items in config/initializers/avo.rb. Use when the user wants to populate icons for sidebar sections, groups, resources, links, and dashboards. Especially useful when migrating from Avo 3 to Avo 4. |
| allowed-tools | Read, Edit, Glob |
| metadata | {"requires-gem":"avo-menu (https://avohq.io/addons/menu-editor) — only for the initializer menu DSL; resource icons are Community"} |
Add Icons to Avo Menu Items
ruby ./scripts/fetch_icons.rb
Before doing anything, fetch the available Tabler icon names grouped by style by running the command above.
That will output the available icons in a file called icons-cache.json in the same directory as the script with the available icons grouped by style (outline and filled).
To use an icon, prefix the name with tabler/outline/ or tabler/filled/ — e.g. icon: "tabler/outline/users".
Only use names that appear in the icons-cache.json file.
Determine the approach
There are two ways to add icons in Avo. Identify which one to use:
Approach A — Initializer menu DSL
Use this when config/initializers/avo.rb contains a config.main_menu or config.profile_menu block. Icons are added inline to the DSL calls inside those blocks. The menu DSL requires the avo-menu paid add-on — if it's not installed, use Approach B instead.