Herald Network¶

Herald is the nervous system of F3L1X - the message broker that enables all realms to communicate with each other securely and efficiently.

What is Herald?¶

Herald is the communication backbone that connects all F3L1X realms together. Think of it as the internal postal service for your AI workforce - it routes messages, broadcasts events, and keeps everything in sync.

"The networking genius that handles all realm-to-realm messaging."

Key Features¶

Message Broadcasting¶

Realms can announce events to all other realms:

┌─────────────────────────────────────────────────────────────────┐
│                     Herald Broadcast                             │
├─────────────────────────────────────────────────────────────────┤
│                                                                  │
│     Realm A sends: "document_indexed"                           │
│                          │                                       │
│                          ▼                                       │
│                    ┌──────────┐                                  │
│                    │  Herald  │                                  │
│                    └────┬─────┘                                  │
│           ┌─────────────┼─────────────┐                         │
│           ▼             ▼             ▼                         │
│      ┌─────────┐  ┌─────────┐  ┌─────────┐                     │
│      │ Realm B │  │ Realm C │  │ Realm D │                     │
│      │ Receives│  │ Receives│  │ Receives│                     │
│      └─────────┘  └─────────┘  └─────────┘                     │
│                                                                  │
└─────────────────────────────────────────────────────────────────┘

When something important happens in one realm, Herald ensures all interested realms are notified.

Direct Messaging¶

Need to communicate with a specific realm? Herald routes messages directly:

Dashboard ────► Herald ────► Documentation
            (routes to)

Real-Time Events¶

Herald supports real-time event streaming, so your dashboard can show live updates:

• When a document is indexed
• When a realm starts or stops
• When tasks are completed
• When issues are detected

Tool Discovery¶

Herald maintains a catalog of all available tools across your realms:

• Search documentation from any realm
• Discover what capabilities are available
• Invoke tools from a central location

How Realms Use Herald¶

Announcing Events¶

When a realm completes important work, it announces to Herald:

1. Documentation realm indexes a new file
2. It sends "document_indexed" event to Herald
3. Herald broadcasts to all subscribed realms
4. Dashboard updates its file count display

Requesting Services¶

When a realm needs something from another:

1. Dashboard wants to search documentation
2. It sends a request through Herald
3. Herald routes to Documentation realm
4. Documentation processes and returns results
5. Dashboard displays the results

Security¶

Herald operates with security-first principles:

• Local-Only Communication - All messages stay on your machine
• Authentication - Realms must authenticate before messaging
• No External Access - Herald doesn't accept connections from the internet

This means your internal communications are protected from external threats.

Event Types¶

Herald handles several categories of events:

System Events¶

• Realm started
• Realm stopped
• Health check
• Alert detected

Document Events¶

• Document indexed
• Document updated
• Document deleted

Session Events¶

• Session started
• Session ended
• Task completed

The Tool Catalog¶

Herald maintains a registry of tools available across all realms:

Some tools may be:
- Free - Available to all users
- Premium - Require subscription or payment

Working with Herald¶

From the Dashboard¶

The Dashboard automatically connects to Herald for:
- Displaying realm status
- Showing notifications
- Routing commands

Understanding Notifications¶

When you see real-time updates in your Dashboard, that's Herald at work:

┌─────────────────────────────────────────┐
│  Notification: Document indexed         │
│  Source: Documentation                  │
│  File: guide.md                         │
└─────────────────────────────────────────┘

Benefits of the Herald Architecture¶

1. Loose Coupling¶

Realms don't need to know about each other's internal workings. They just send messages through Herald.

2. Reliability¶

If a realm is temporarily unavailable, Herald can queue messages for later delivery.

3. Scalability¶

Adding new realms is easy - they just register with Herald and start communicating.

4. Visibility¶

The Dashboard can subscribe to all events and show you what's happening across your entire AI workforce.

Common Questions¶

Does Herald use the internet?¶

No. Herald operates entirely on your local machine. It only facilitates communication between realms running on your computer.

What if Herald stops running?¶

If Herald stops, realms can still operate independently but won't be able to communicate with each other. Restart F3L1X to restore Herald.

Can I see Herald's messages?¶

The Dashboard shows notifications from Herald events. For detailed logs, check the F3L1X logs.

Next Steps¶

• Understanding Realms - Learn about the agent modules
• Pipeline-Go Methodology - Development workflow
• Security & Privacy - How F3L1X protects your data