GeneralBots/generalbots
2
1
Fork 0
Code Activity Actions 4
generalbots/botbook/src/01-getting-started
History
Rodrigo Rodriguez (Pragmatismo) 037db5c381 feat: Major workspace reorganization and documentation update 
- Add comprehensive documentation in botbook/ with 12 chapters
- Add botapp/ Tauri desktop application
- Add botdevice/ IoT device support
- Add botlib/ shared library crate
- Add botmodels/ Python ML models service
- Add botplugin/ browser extension
- Add botserver/ reorganized server code
- Add bottemplates/ bot templates
- Add bottest/ integration tests
- Add botui/ web UI server
- Add CI/CD workflows in .forgejo/workflows/
- Add AGENTS.md and PROD.md documentation
- Add dependency management scripts (DEPENDENCIES.sh/ps1)
- Remove legacy src/ structure and migrations
- Clean up temporary and backup files
2026-04-19 08:14:25 -03:00
..
assets feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00
first-conversation.md feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00
installation.md feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00
local-domains.md feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00
overview.md feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00
quick-start.md feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00
README.md feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00
sessions.md feat: Major workspace reorganization and documentation update 2026-04-19 08:14:25 -03:00

README.md

Chapter 01: Run and Talk

⚡ In a hurry? Jump straight to Quick Start — you'll be chatting with your bot in 5 minutes.

Get General Bots running and have your first conversation.

What You'll Achieve

By the end of this chapter, you will:

  • Have General Bots running on your machine
  • Understand what happens during bootstrap
  • Complete your first conversation with a bot
  • Know how sessions and channels work

Choose Your Path

If You Want To... Go To
Get running immediately Quick Start
Understand the architecture first Overview
See all installation options Installation
Learn about conversations First Conversation
Understand session management Sessions and Channels

The 30-Second Version

./botserver

Open http://localhost:9000. Start chatting. That's it.

Everything installs automatically on first run—PostgreSQL, storage, cache, and your first bot.

How It Works

How do I get started with General Bots?

09:00

Just three steps:

1️⃣ Download botserver

2️⃣ Run ./botserver

3️⃣ Open your browser to localhost:9000

The bootstrap process handles everything else automatically!

09:00

What gets installed?

09:01

PostgreSQL (database)

MinIO (file storage)

Cache (Redis-compatible)

Default bot templates

All in botserver-stack/ — no system-wide installation!

09:01

Topics in This Chapter

Overview

What General Bots does and how it fits together.

Quick Start

The fastest path from zero to running bot.

Installation

Detailed setup options including LXC containers and production deployment.

First Conversation

Understanding how the bot responds and learns.

Sessions and Channels

How conversations are managed across WhatsApp, Web, Telegram, and more.

Coming From Executive Vision?

If you just read the Executive Vision, here's what to know:

  1. Everything in that feature table? It's all included in the single botserver binary
  2. No configuration needed — Bootstrap detects your system and sets everything up
  3. Start simple — Run it, chat with it, then customize

The philosophy is: get running first, understand later.

Prerequisites

  • Operating System: Linux, macOS, or Windows (WSL2 recommended)
  • Disk Space: ~2GB for botserver-stack
  • RAM: 4GB minimum, 8GB recommended
  • Ports: 8080 (web), 5432 (database), 9000 (storage)

No Docker required. No cloud accounts. No API keys to start.

Next Step

Quick Start →

General Bots