# Summary

[Executive Vision](./executive-vision.md)
[Roadmap 2024-2026](./ROADMAP.md)
[Introduction](./introduction.md)

# Part I - Getting Started

- [Chapter 01: Run and Talk](./01-introduction/README.md)
  - [Overview](./01-introduction/overview.md)
  - [Quick Start](./01-introduction/quick-start.md)
  - [Configuring .local Domains](./01-introduction/local-domains.md)
  - [Installation](./01-introduction/installation.md)
  - [First Conversation](./01-introduction/first-conversation.md)
  - [Sessions and Channels](./01-introduction/sessions.md)

# Part II - Package System

- [Chapter 02: About Packages](./02-templates/README.md)
  - [.gbai Architecture](./02-templates/gbai.md)
  - [.gbdialog Dialogs](./02-templates/gbdialog.md)
  - [.gbkb Knowledge Base](./02-templates/gbkb.md)
  - [.gbot Bot Configuration](./02-templates/gbot.md)
  - [.gbtheme UI Theming](./02-templates/gbtheme.md)
  - [.gbdrive File Storage](./02-templates/gbdrive.md)
  - [Bot Templates](./02-templates/templates.md)
  - [Template Samples & Conversations](./02-templates/template-samples.md)
  - [Template: Business Intelligence](./02-templates/template-bi.md)
  - [Template: Web Crawler](./02-templates/template-crawler.md)
  - [Template: Legal Documents](./02-templates/template-law.md)
  - [Template: LLM Server](./02-templates/template-llm-server.md)
  - [Template: LLM Tools](./02-templates/template-llm-tools.md)
  - [Template: API Client](./02-templates/template-api-client.md)
  - [Template: Platform Analytics](./02-templates/template-analytics.md)
  - [Template: Office Automation](./02-templates/template-office.md)
  - [Template: Reminders](./02-templates/template-reminder.md)
  - [Template: Sales CRM](./02-templates/template-crm.md)
  - [Template: CRM Contacts](./02-templates/template-crm-contacts.md)
  - [Template: Attendance CRM](./02-templates/template-attendance-crm.md)
  - [Template: Marketing](./02-templates/template-marketing.md)
  - [Template: Embedded Devices](./02-templates/template-embedded.md)
  - [Template: Creating Templates](./02-templates/template-template.md)

# Part III - Knowledge Base

- [Chapter 03: gbkb Reference](./03-knowledge-base/README.md)
  - [KB and Tools System](./03-knowledge-base/kb-and-tools.md)
  - [Vector Collections](./03-knowledge-base/vector-collections.md)
  - [Document Indexing](./03-knowledge-base/indexing.md)
  - [Semantic Search](./03-knowledge-base/semantic-search.md)
  - [Episodic Memory](./03-knowledge-base/episodic-memory.md)
  - [Semantic Caching](./03-knowledge-base/caching.md)

# Part IV - User Interface

- [Chapter 04: .gbui Interface Reference](./04-gbui/README.md)
  - [Suite User Manual](./04-gbui/suite-manual.md)
  - [Admin vs User Views](./04-gbui/admin-user-views.md)
  - [UI Structure](./04-gbui/ui-structure.md)
  - [single.gbui - Simple Chat](./04-gbui/single-gbui.md)
  - [Console Mode](./04-gbui/console-mode.md)
  - [Monitoring Dashboard](./04-gbui/monitoring.md)
  - [HTMX Architecture](./04-gbui/htmx-architecture.md)
  - [Suite Applications](./04-gbui/apps/README.md)
    - [Suite - Full Desktop](./04-gbui/apps/suite.md)
    - [Chat - AI Assistant](./04-gbui/apps/chat.md)
    - [Drive - File Management](./04-gbui/apps/drive.md)
    - [Tasks](./04-gbui/apps/tasks.md)
    - [Mail - Email Client](./04-gbui/apps/mail.md)
    - [Calendar - Scheduling](./04-gbui/apps/calendar.md)
    - [Meet - Video Calls](./04-gbui/apps/meet.md)
    - [Player - Media Viewer](./04-gbui/apps/player.md)
    - [Paper - AI Writing](./04-gbui/apps/paper.md)
    - [Research - AI Search](./04-gbui/apps/research.md)
    - [Analytics - Dashboards](./04-gbui/apps/analytics.md)
    - [Designer - Visual Builder](./04-gbui/apps/designer.md)
    - [Sources - Prompts & Templates](./04-gbui/apps/sources.md)
    - [Compliance - Security Scanner](./04-gbui/apps/compliance.md)
    - [Compliance API Reference](./04-gbui/apps/compliance-api.md)
  - [How-To Tutorials](./04-gbui/how-to/README.md)
    - [Create Your First Bot](./04-gbui/how-to/create-first-bot.md)
    - [Write Your First Dialog](./04-gbui/how-to/write-first-dialog.md)
    - [Add Documents to Knowledge Base](./04-gbui/how-to/add-kb-documents.md)
    - [Connect WhatsApp](./04-gbui/how-to/connect-whatsapp.md)
    - [Monitor Your Bot](./04-gbui/how-to/monitor-sessions.md)

# Part V - Themes and Styling

- [Chapter 05: gbtheme CSS Reference](./05-gbtheme/README.md)
  - [Theme Structure](./05-gbtheme/structure.md)
  - [CSS Customization](./05-gbtheme/css.md)

# Part VI - BASIC Dialogs

- [Chapter 06: gbdialog Reference](./06-gbdialog/README.md)
  - [Dialog Basics](./06-gbdialog/basics.md)
  - [API Possibilities](./06-gbdialog/api-possibilities.md)
  - [Universal Messaging & Multi-Channel](./06-gbdialog/universal-messaging.md)
  - [BASIC vs n8n/Zapier/Make](./06-gbdialog/basic-vs-automation-tools.md)
  - [Template Variables](./06-gbdialog/template-variables.md)
  - [Template Examples](./06-gbdialog/templates.md)
    - [start.bas](./06-gbdialog/templates/start.md)
    - [enrollment.bas](./06-gbdialog/templates/enrollment.md)
    - [auth.bas](./06-gbdialog/templates/auth.md)
    - [ai-search.bas](./06-gbdialog/templates/ai-search.md)
    - [analytics-dashboard.bas](./06-gbdialog/templates/analytics-dashboard.md)
    - [announcements.bas](./06-gbdialog/templates/announcements.md)
    - [backup.bas](./06-gbdialog/templates/backup.md)
    - [bank.bas](./06-gbdialog/templates/bank.md)
    - [broadcast.bas](./06-gbdialog/templates/broadcast.md)
    - [default.bas](./06-gbdialog/templates/default.md)
    - [edu.bas](./06-gbdialog/templates/edu.md)
    - [employees.bas](./06-gbdialog/templates/employees.md)
    - [erp.bas](./06-gbdialog/templates/erp.md)
    - [helpdesk.bas](./06-gbdialog/templates/helpdesk.md)
    - [privacy.bas](./06-gbdialog/templates/privacy.md)
    - [sales-pipeline.bas](./06-gbdialog/templates/sales-pipeline.md)
    - [store.bas](./06-gbdialog/templates/store.md)
    - [talk-to-data.bas](./06-gbdialog/templates/talk-to-data.md)
    - [whatsapp.bas](./06-gbdialog/templates/whatsapp.md)
  - [Webhook Integrations and Jobs](./06-gbdialog/examples-consolidated.md)
  - [Data Sync Tools](./06-gbdialog/tools-data-sync.md)
  - [Keywords Reference](./06-gbdialog/keywords.md)
    - [TALK](./06-gbdialog/keyword-talk.md)
    - [HEAR](./06-gbdialog/keyword-hear.md)
    - [SET CONTEXT](./06-gbdialog/keyword-set-context.md)
    - [GET BOT MEMORY](./06-gbdialog/keyword-get-bot-memory.md)
    - [SET BOT MEMORY](./06-gbdialog/keyword-set-bot-memory.md)
    - [GET USER MEMORY](./06-gbdialog/keyword-get-user-memory.md)
    - [SET USER MEMORY](./06-gbdialog/keyword-set-user-memory.md)
    - [REMEMBER / RECALL](./06-gbdialog/keyword-remember.md)
    - [BOOK / BOOK_MEETING](./06-gbdialog/keyword-book.md)
    - [WEATHER / FORECAST](./06-gbdialog/keyword-weather.md)
    - [ADD BOT](./06-gbdialog/keyword-add-bot.md)
    - [ADD MEMBER](./06-gbdialog/keyword-add-member.md)
    - [ADD SUGGESTION](./06-gbdialog/keyword-add-suggestion.md)
    - [MODEL ROUTE](./06-gbdialog/keyword-model-route.md)
    - [SEND TEMPLATE](./06-gbdialog/keyword-send-template.md)
    - [SET USER](./06-gbdialog/keyword-set-user.md)
    - [USE MODEL](./06-gbdialog/keyword-use-model.md)
    - [DELEGATE TO BOT](./06-gbdialog/keyword-delegate-to-bot.md)
    - [BOT REFLECTION](./06-gbdialog/keyword-bot-reflection.md)
    - [RUN PYTHON / JAVASCRIPT / BASH](./06-gbdialog/keyword-run-code.md)
    - [USE KB](./06-gbdialog/keyword-use-kb.md)
    - [CLEAR KB](./06-gbdialog/keyword-clear-kb.md)
    - [USE WEBSITE](./06-gbdialog/keyword-use-website.md)
    - [USE TOOL](./06-gbdialog/keyword-use-tool.md)
    - [CLEAR TOOLS](./06-gbdialog/keyword-clear-tools.md)
    - [GET](./06-gbdialog/keyword-get.md)
    - [SET](./06-gbdialog/keyword-set.md)
    - [ON](./06-gbdialog/keyword-on.md)
    - [SET SCHEDULE](./06-gbdialog/keyword-set-schedule.md)
    - [CREATE SITE](./06-gbdialog/keyword-create-site.md)
    - [CREATE DRAFT](./06-gbdialog/keyword-create-draft.md)
    - [CREATE TASK](./06-gbdialog/keyword-create-task.md)
    - [PRINT](./06-gbdialog/keyword-print.md)
    - [WAIT](./06-gbdialog/keyword-wait.md)
    - [FORMAT](./06-gbdialog/keyword-format.md)
    - [FIRST](./06-gbdialog/keyword-first.md)
    - [LAST](./06-gbdialog/keyword-last.md)
    - [FOR EACH](./06-gbdialog/keyword-for-each.md)
    - [EXIT FOR](./06-gbdialog/keyword-exit-for.md)
    - [SEND MAIL](./06-gbdialog/keyword-send-mail.md)
    - [FIND](./06-gbdialog/keyword-find.md)
    - [INSTR](./06-gbdialog/keyword-instr.md)
    - [IS NUMERIC](./06-gbdialog/keyword-is-numeric.md)
    - [SWITCH](./06-gbdialog/keyword-switch.md)
    - [WEBHOOK](./06-gbdialog/keyword-webhook.md)
    - [TABLE](./06-gbdialog/keyword-table.md)
  - [KB Statistics Keywords](./06-gbdialog/keywords-kb-statistics.md)
    - [KB STATISTICS](./06-gbdialog/keyword-kb-statistics.md)
    - [KB COLLECTION STATS](./06-gbdialog/keyword-kb-collection-stats.md)
    - [KB DOCUMENTS COUNT](./06-gbdialog/keyword-kb-documents-count.md)
    - [KB DOCUMENTS ADDED SINCE](./06-gbdialog/keyword-kb-documents-added-since.md)
    - [KB LIST COLLECTIONS](./06-gbdialog/keyword-kb-list-collections.md)
    - [KB STORAGE SIZE](./06-gbdialog/keyword-kb-storage-size.md)
  - [Multi-Agent Keywords](./06-gbdialog/keywords-multi-agent.md)
  - [Social Media Keywords](./06-gbdialog/keywords-social-media.md)
  - [Lead Scoring Keywords](./06-gbdialog/keywords-lead-scoring.md)
  - [HTTP & API Operations](./06-gbdialog/keywords-http.md)
    - [POST](./06-gbdialog/keyword-post.md)
    - [PUT](./06-gbdialog/keyword-put.md)
    - [PATCH](./06-gbdialog/keyword-patch.md)
    - [DELETE HTTP](./06-gbdialog/keyword-delete-http.md)
    - [SET HEADER](./06-gbdialog/keyword-set-header.md)
    - [GRAPHQL](./06-gbdialog/keyword-graphql.md)
    - [SOAP](./06-gbdialog/keyword-soap.md)
  - [Data Operations](./06-gbdialog/keywords-data.md)
    - [SAVE](./06-gbdialog/keyword-save.md)
    - [INSERT](./06-gbdialog/keyword-insert.md)
    - [UPDATE](./06-gbdialog/keyword-update.md)
    - [DELETE](./06-gbdialog/keyword-delete.md)
    - [MERGE](./06-gbdialog/keyword-merge.md)
    - [FILL](./06-gbdialog/keyword-fill.md)
    - [MAP](./06-gbdialog/keyword-map.md)
    - [FILTER](./06-gbdialog/keyword-filter.md)
    - [AGGREGATE](./06-gbdialog/keyword-aggregate.md)
    - [JOIN](./06-gbdialog/keyword-join.md)
    - [PIVOT](./06-gbdialog/keyword-pivot.md)
    - [GROUP BY](./06-gbdialog/keyword-group-by.md)
  - [Media & Messaging](./06-gbdialog/keywords-media.md)
    - [PLAY](./06-gbdialog/keyword-play.md)
    - [QR CODE](./06-gbdialog/keyword-qrcode.md)
    - [SEND SMS](./06-gbdialog/keyword-sms.md)
    - [START MEET / JOIN MEET](./06-gbdialog/keyword-start-meet.md)
  - [GPIO & IoT Keywords](./06-gbdialog/keywords-gpio.md)
  - [File Operations](./06-gbdialog/keywords-file.md)
    - [READ](./06-gbdialog/keyword-read.md)
    - [WRITE](./06-gbdialog/keyword-write.md)
    - [DELETE FILE](./06-gbdialog/keyword-delete-file.md)
    - [COPY](./06-gbdialog/keyword-copy.md)
    - [MOVE](./06-gbdialog/keyword-move.md)
    - [LIST](./06-gbdialog/keyword-list.md)
    - [COMPRESS](./06-gbdialog/keyword-compress.md)
    - [EXTRACT](./06-gbdialog/keyword-extract.md)
    - [UPLOAD](./06-gbdialog/keyword-upload.md)
    - [DOWNLOAD](./06-gbdialog/keyword-download.md)
    - [GENERATE PDF](./06-gbdialog/keyword-generate-pdf.md)
    - [MERGE PDF](./06-gbdialog/keyword-merge-pdf.md)

# Part VII - Extending General Bots

- [Chapter 07: gbapp Architecture Reference](./07-gbapp/README.md)
  - [Architecture Overview](./07-gbapp/architecture.md)
  - [Building from Source](./07-gbapp/building.md)
  - [Cargo Tools Reference](./07-gbapp/cargo-tools.md)
  - [Container Deployment (LXC)](./07-gbapp/containers.md)
  - [Docker Deployment](./07-gbapp/docker-deployment.md)
  - [Scaling and Load Balancing](./07-gbapp/scaling.md)
  - [Infrastructure Design](./07-gbapp/infrastructure.md)
  - [Observability](./07-gbapp/observability.md)
  - [Autonomous Task AI](./07-gbapp/autonomous-tasks.md)
  - [Philosophy](./07-gbapp/philosophy.md)
  - [Example gbapp](./07-gbapp/example-gbapp.md)
  - [Module Structure](./07-gbapp/crates.md)
  - [Service Layer](./07-gbapp/services.md)
  - [Creating Custom Keywords](./07-gbapp/custom-keywords.md)
  - [Adding Dependencies](./07-gbapp/dependencies.md)

# Part VIII - Bot Configuration

- [Chapter 08: gbot Reference](./08-config/README.md)
  - [config.csv Format](./08-config/config-csv.md)
  - [Bot Parameters](./08-config/parameters.md)
  - [LLM Configuration](./08-config/llm-config.md)
  - [Context Configuration](./08-config/context-config.md)
  - [Drive Integration](./08-config/drive.md)
  - [Multimodal Configuration](./08-config/multimodal.md)
  - [Secrets Management](./08-config/secrets-management.md)

# Part IX - Tools and Integration

- [Chapter 09: LLM Tools](./09-tools/README.md)
  - [Tool Definition](./09-tools/tool-definition.md)
  - [PARAM Declaration](./09-tools/param-declaration.md)
  - [Tool Compilation](./09-tools/compilation.md)
  - [MCP Format](./09-tools/mcp-format.md)
  - [Tool Format](./09-tools/openai-format.md)
  - [GET Keyword Integration](./09-tools/get-integration.md)
  - [External APIs](./09-tools/external-apis.md)
  - [LLM REST Server](./09-tools/llm-rest-server.md)
  - [NVIDIA GPU Setup for LXC](./09-tools/nvidia-gpu-setup.md)

- [Chapter 10: REST Endpoints](./10-rest/README.md)
  - [Files API](./10-rest/files-api.md)
  - [Document Processing API](./10-rest/document-processing.md)
  - [Users API](./10-rest/users-api.md)
  - [User Security API](./10-rest/user-security.md)
  - [Groups API](./10-rest/groups-api.md)
  - [Group Membership API](./10-rest/group-membership.md)
  - [Conversations API](./10-rest/conversations-api.md)
  - [Calls API](./10-rest/calls-api.md)
  - [Whiteboard API](./10-rest/whiteboard-api.md)
  - [Email API](./10-rest/email-api.md)
  - [Notifications API](./10-rest/notifications-api.md)
  - [Calendar API](./10-rest/calendar-api.md)
  - [Tasks API](./10-rest/tasks-api.md)
  - [Storage API](./10-rest/storage-api.md)
  - [Backup API](./10-rest/backup-api.md)
  - [Analytics API](./10-rest/analytics-api.md)
  - [Reports API](./10-rest/reports-api.md)
  - [Admin API](./10-rest/admin-api.md)
  - [Monitoring API](./10-rest/monitoring-api.md)
  - [AI API](./10-rest/ai-api.md)
  - [ML API](./10-rest/ml-api.md)
  - [Security API](./10-rest/security-api.md)
  - [Compliance API](./10-rest/compliance-api.md)
  - [Example Integrations](./10-rest/examples.md)

# Part X - Feature Deep Dive

- [Chapter 11: Feature Reference](./11-features/README.md)
  - [Feature Editions](./11-features/editions.md)
  - [Core Features](./11-features/core-features.md)
  - [Conversation Management](./11-features/conversation.md)
  - [AI and LLM](./11-features/ai-llm.md)
  - [Knowledge Base](./11-features/knowledge-base.md)
  - [Automation](./11-features/automation.md)
  - [Email Integration](./11-features/email.md)
  - [Storage and Data](./11-features/storage.md)
  - [Multi-Channel Support](./11-features/channels.md)
  - [Drive Monitor](./11-features/drive-monitor.md)
  - [Platform Capabilities](./11-features/platform-comparison.md)
  - [Enterprise Platform Migration](./11-features/m365-comparison.md)
  - [Projects](./11-features/projects.md)
  - [Multi-Agent Office Suite Design](./11-features/multi-agent-design.md)
  - [What's New: Multi-Agent Features](./11-features/whats-new.md)
  - [Multi-Agent Orchestration](./11-features/multi-agent-orchestration.md)
  - [Memory Management](./11-features/memory-management.md)
  - [Hybrid RAG Search](./11-features/hybrid-search.md)
  - [Transfer to Human](./11-features/transfer-to-human.md)
  - [LLM-Assisted Attendant](./11-features/attendant-llm-assist.md)

# Part XI - Security

- [Chapter 12: Authentication & Permissions](./12-auth/README.md)
  - [User Authentication](./12-auth/user-auth.md)
  - [Password Security](./12-auth/password-security.md)
  - [API Endpoints](./12-auth/api-endpoints.md)
  - [Bot Authentication](./12-auth/bot-auth.md)
  - [Security Features](./12-auth/security-features.md)
  - [Security Policy](./12-auth/security-policy.md)
  - [Compliance Requirements](./12-auth/compliance-requirements.md)
  - [Permissions Matrix](./12-auth/permissions-matrix.md)
  - [User Context vs System Context](./12-auth/user-system-context.md)

# Part XII - Device & Offline Deployment

- [Chapter 13: Device Deployment](./13-devices/README.md)
  - [Buying Guide for Beginners](./13-devices/buying-guide.md)
  - [Mobile (Android & HarmonyOS)](./13-devices/mobile.md)
  - [Supported Hardware (SBCs)](./13-devices/hardware.md)
  - [Quick Start](./13-devices/quick-start.md)
  - [Local LLM with llama.cpp](./13-devices/local-llm.md)

# Part XIII - Community

- [Chapter 14: Contributing](./13-community/README.md)
  - [Development Setup](./13-community/setup.md)
  - [Testing Guide](./13-community/testing.md)
  - [Documentation](./13-community/documentation.md)
  - [Pull Requests](./13-community/pull-requests.md)
  - [Community Guidelines](./13-community/community.md)
  - [IDEs](./13-community/ide-extensions.md)

# Part XIV - Migration

- [Chapter 15: Migration Guide](./14-migration/README.md)
  - [Migration Overview](./14-migration/overview.md)
  - [Platform Comparison Matrix](./14-migration/comparison-matrix.md)
  - [Migration Resources](./14-migration/resources.md)
  - [Common Concepts](./14-migration/common-concepts.md)
  - [Knowledge Base Migration](./14-migration/kb-migration.md)
  - [Cloud Productivity Migration](./14-migration/google-workspace.md)
  - [Enterprise Platform Migration](./14-migration/microsoft-365.md)
  - [n8n Migration](./14-migration/n8n.md)
  - [Notion Migration](./14-migration/notion.md)
  - [Perplexity Migration](./14-migration/perplexity.md)
  - [Zapier and Make Migration](./14-migration/zapier-make.md)
  - [Intercom Migration](./14-migration/intercom.md)
  - [Dialogflow Migration](./14-migration/dialogflow.md)
  - [Botpress Migration](./14-migration/botpress.md)
  - [Automation Migration](./14-migration/automation.md)
  - [Validation and Testing](./14-migration/validation.md)

# Part XV - Testing

- [Chapter 16: Testing](./17-testing/README.md)
  - [End-to-End Testing](./17-testing/e2e-testing.md)
  - [Testing Architecture](./17-testing/architecture.md)
  - [Performance Testing](./17-testing/performance.md)
  - [Best Practices](./17-testing/best-practices.md)
  - [CI/CD Integration](./17-testing/ci-cd.md)

# Appendices

- [Appendix A: Database Model](./15-appendix/README.md)
  - [Schema Overview](./15-appendix/schema.md)
  - [Tables](./15-appendix/tables.md)
  - [Relationships](./15-appendix/relationships.md)

- [Appendix B: External Services](./18-appendix-external-services/README.md)
  - [Service Catalog](./18-appendix-external-services/catalog.md)
  - [LLM Providers](./18-appendix-external-services/llm-providers.md)
  - [Weather API](./18-appendix-external-services/weather.md)
  - [Channel Integrations](./18-appendix-external-services/channels.md)
  - [Storage Services](./18-appendix-external-services/storage.md)
  - [Directory Services](./18-appendix-external-services/directory.md)
  - [Attendance Queue](./18-appendix-external-services/attendance-queue.md)
  - [Hosting, DNS, and MDA](./18-appendix-external-services/hosting-dns.md)
  - [Time-Series Database](./18-appendix-external-services/timeseries.md)
  - [NVIDIA GPU](./18-appendix-external-services/nvidia.md)
  - [Multimodal](./18-appendix-external-services/multimodal.md)
  - [Console (XtreeUI)](./18-appendix-external-services/console.md)

- [Appendix C: Maintenance](./19-maintenance/README.md)
  - [Updating Components](./19-maintenance/updating-components.md)
  - [Component Reference](./19-maintenance/component-reference.md)
  - [Security Auditing](./19-maintenance/security-auditing.md)
  - [Backup and Recovery](./19-maintenance/backup-recovery.md)
  - [Troubleshooting](./19-maintenance/troubleshooting.md)


[Glossary](./glossary.md)
[Contact](./contact/README.md)
