Skip to content

Docs: Guide for building a custom installer with a custom agent #776

@kovtcharov-amd

Description

@kovtcharov-amd

Summary

Create a user guide documenting how to build a custom GAIA installer that ships with a pre-configured custom agent. This enables OEMs, enterprises, and power users to distribute turnkey GAIA packages tailored to their use case.

Scope

Write a guide in docs/guides/ (or docs/playbooks/) covering:

1. Building a custom agent

  • Creating an agent by extending the base Agent class (src/gaia/agents/base/agent.py)
  • Registering tools with the @tool decorator
  • Adding MCP support via MCPAgent mixin
  • Configuring the agent's system prompt, default model, and tools

2. Packaging the agent into GAIA

  • Adding the agent to the agent registry
  • Wiring it into the CLI (src/gaia/cli.py)
  • Setting it as the default agent in the installer config

3. Building the installer

  • Customizing the NSIS installer (installer/nsis/installer.nsh)
  • Branding options (app name, icon, splash screen)
  • Bundling specific models and Lemonade version
  • CI/CD pipeline for building the installer artifact

4. Distribution

  • Signing the installer
  • Update channels
  • Model pre-download vs. first-run download trade-offs

Audience

  • OEM partners building vertical AI solutions on AMD hardware
  • Enterprise teams deploying domain-specific agents internally
  • Community contributors building and sharing custom agents

Related issues

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestwebsiteGAIA website (amd-gaia.ai)

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions