-
Notifications
You must be signed in to change notification settings - Fork 185
GITBOOK-28: Initial Documentation #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
074b438
9d04f95
8f2caf2
6f24af9
dff04c8
07b762d
8a66739
8bcaa44
dc33b7c
dbd54a1
b0e3734
6dabf13
bf94761
ab22c2c
01c0df9
65f4762
20058f7
50ec8c6
3faff24
57ddbaf
040122b
8e7af1e
31ae1a3
f5d26d0
512bcc5
642cd77
efeb651
162a2d8
24e22ff
349dc32
62483e7
4f5a5ca
a829078
fd81adb
c078aad
6d299c1
8283d89
136d189
4eb8c3d
d712588
0261162
da16a36
021deb8
34af711
17881fa
7c45d4e
938b108
80ac407
59a4c07
824dc43
e1f0ddb
d74229a
fddf035
bbb0ae0
e9690b0
2a108b9
e1e611a
91d8987
d5e6790
e3e31f6
8f70e82
d3c1764
597bf96
a5ad765
a3ca24d
d751fdf
546bd0d
77a4d14
fb82bb4
a4c8eda
eff83c6
1c25297
1af846f
bb10eca
5534096
c2d4a40
133a90c
a35f4d8
4d864fc
df7271a
ce85982
934d401
14de5f7
7f5289c
f65bc49
ef523cb
0b19a94
51e7ae6
060673d
8d9fb50
4ea2aac
15bdd32
bd6b8f2
62face2
7b3b96b
5aa350d
e0754db
595887b
60e05a4
24032b6
d0c416a
c25697f
974c486
6664cc0
449faef
26cccb4
b98afd4
5d66fc1
b801789
d25eb98
0049713
0b047f1
ebe3bf9
2f8613d
0ec13cd
adcd387
3375edc
c53580b
ff1ede0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Add/Edit Keyword Entity Form | ||
| --- | ||
|
|
||
| <figure><img src="../assets/image (38).png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Add/Edit NLU Trait Value Form | ||
| --- | ||
|
|
||
| <figure><img src="../assets/image (39).png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Add/Edit Pattern Entity Form | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Screenshot 2025-09-16 at 15-55-06 Hexabot.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Add New Content Type Form | ||
| --- | ||
|
|
||
| <figure><img src="../assets/image (35).png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Attachement Block | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Screenshot 2025-09-15 at 16-47-12 Hexabot.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Buttons Block | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Screenshot 2025-09-15 at 16-46-02 Hexabot.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: List Block | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Screenshot 2025-09-15 at 16-48-45 Hexabot.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: NLU Samples Tab | ||
| --- | ||
|
|
||
| <figure><img src="../assets/image (37).png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Quick Replies Block | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Screenshot 2025-09-15 at 16-44-44 Hexabot.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Simle Text Block | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Screenshot 2025-09-15 at 16-42-40 Hexabot.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Time Plugin Settings | ||
| --- | ||
|
|
||
| <figure><img src="../assets/time-Plugin-settings.jpg" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| title: Untitled | ||
| --- | ||
|
|
||
| {% content-ref url="../../developer-guide/setup-node.js-with-nvm.md" %} | ||
| [setup-node.js-with-nvm.md](../../developer-guide/setup-node.js-with-nvm.md) | ||
| {% endcontent-ref %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Setup Node.js with NVM | ||
| --- | ||
|
|
||
| <figure><img src="../assets/image.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Visual Editor Screenshot | ||
| --- | ||
|
|
||
| <figure><img src="../assets/bb20d6a1-cfd5-48ca-a3a9-da27bcf521be.png" alt=""><figcaption><p>Browse Flows in the Visual Editor</p></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Visual Editor UI | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Dark.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Visuel Editor UI | ||
| --- | ||
|
|
||
| <figure><img src="../assets/Dark.png" alt=""><figcaption><p>A preview of Hexabot visual editor</p></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| title: Visuel Editor with Simple Text Block | ||
| --- | ||
|
|
||
| <figure><img src="../assets/1f0a335a-af75-4fab-8ee9-ce54d9e22a8d.png" alt=""><figcaption></figcaption></figure> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| icon: house-window | ||
| --- | ||
|
|
||
| # Welcome | ||
|
|
||
| Welcome to the Hexabot Documentation! Hexabot is a powerful and versatile open-source chatbot platform designed to simplify the creation and management of intelligent conversational chatbots. Whether you're a business owner seeking to automate customer interactions, an organization looking to engage your audience, or a developer wanting to integrate conversational AI into your applications, Hexabot provides the tools and flexibility you need. | ||
|
|
||
| {% include ".gitbook/includes/visuel-editor-ui.md" %} | ||
|
|
||
| ## Key Features | ||
|
|
||
| Hexabot comes equipped with a comprehensive suite of features to empower your chatbot development: | ||
|
|
||
| * **Intuitive Visual Editor:** Build complex conversation flows without coding using our drag-and-drop interface and a diverse library of pre-built blocks. | ||
| * **NLU Engine:** Leverage state-of-the-art NLU technology to understand user intent, extract key information, and deliver personalized responses. | ||
| * **Flexible Deployment Options:** Deploy your chatbots on various platforms, including Facebook Messenger, web widgets, and custom integrations. | ||
| * **Comprehensive Analytics and Reporting:** Track key metrics, monitor chatbot performance, and gain valuable insights into user interactions. | ||
| * **And More:** Discover a range of additional features, including user segmentation, content management, and third-party integrations. | ||
|
|
||
| ## Who Should Use This Documentation | ||
|
|
||
| This documentation is a valuable resource for: | ||
|
|
||
| * **New Users:** Get started with Hexabot, learn the basics of chatbot creation, and build your first conversational chatbot. | ||
| * **Experienced Users**: Explore advanced features, optimize your existing chatbots, and discover best practices for chatbot development. | ||
| * **Developers**: Integrate Hexabot with your applications, leverage our APIs, and extend the platform's functionality by developing add-ons for Hexabot. | ||
| * **Administrators**: Manage users, configure settings, and ensure the smooth operation of Hexabot within your organization. | ||
|
|
||
| ## How to Use This Documentation | ||
|
|
||
| To navigate this documentation effectively: | ||
|
|
||
| * **Search**: Use the search bar to quickly find information on specific topics or keywords. | ||
| * **Navigation**: Browse through the table of contents to explore different sections and find the information you need. | ||
| * **Links**: Follow links to related articles and resources for in-depth explanations and examples. | ||
|
|
||
| Feedback: We encourage you to provide feedback and suggestions for improvement. Your input helps us make this documentation even better.  | ||
|
|
||
| ## Contacting Support | ||
|
|
||
| If you encounter any issues or have questions not addressed in this documentation, our dedicated support team is here to assist you. Please contact us at [[email protected]](mailto:[email protected]) | ||
|
|
||
| ### Jump right in | ||
|
|
||
| <table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Install Hexabot and create your first flow</td><td><a href=".gitbook/assets/1.png">1.png</a></td><td></td><td><a href="quickstart/installation.md">installation.md</a></td></tr><tr><td><strong>Product overview</strong></td><td>Key Features and Capabilities</td><td><a href=".gitbook/assets/4.png">4.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>User Guide</strong></td><td>Learn the basics of Hexabot</td><td><a href=".gitbook/assets/2.png">2.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Developer Guide</strong></td><td>Learn how to develop for Hexabot</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Key Concepts</strong></td><td>Understanding the Fundamentals of Chatbot Building</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table> | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,78 @@ | ||||||
| # Table of contents | ||||||
|
|
||||||
| * [Welcome](README.md) | ||||||
|
|
||||||
| ## Introduction | ||||||
|
|
||||||
| * [Overview](introduction/overview.md) | ||||||
| * [Features](introduction/features.md) | ||||||
|
|
||||||
| ## Quickstart | ||||||
|
|
||||||
| * [Installation](quickstart/installation.md) | ||||||
| * [Create your first flow](quickstart/create-your-first-flow.md) | ||||||
|
|
||||||
| ## USER GUIDE | ||||||
|
|
||||||
| * [Visual Editor](user-guide/visual-editor/README.md) | ||||||
| * [Using the Visual Editor](user-guide/visual-editor/using-the-visual-editor.md) | ||||||
| * [Regular Blocks](user-guide/visual-editor/regular-blocks/README.md) | ||||||
| * [Using Simple Text Block](user-guide/visual-editor/regular-blocks/using-simple-text-block.md) | ||||||
| * [Using Quick Replies Block](user-guide/visual-editor/regular-blocks/using-quick-replies-block.md) | ||||||
| * [Using Buttons Block](user-guide/visual-editor/regular-blocks/using-buttons-block.md) | ||||||
| * [Using Attachment Block](user-guide/visual-editor/regular-blocks/using-attachment-block.md) | ||||||
| * [Using Advanced Blocks](user-guide/visual-editor/using-advanced-blocks.md) | ||||||
| * [Flows](user-guide/flows.md) | ||||||
| * [NLU](user-guide/nlu/README.md) | ||||||
| * [NLU Engines](user-guide/nlu/nlu-engines/README.md) | ||||||
| * [LLM NLU Engine](user-guide/nlu/nlu-engines/llm-nlu-engine.md) | ||||||
| * [Ludwig NLU Engine](user-guide/nlu/nlu-engines/ludwig-nlu-engine.md) | ||||||
| * [Tensorflow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md) | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct proper noun capitalization: TensorFlow Spelling should be “TensorFlow”. - * [Tensorflow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)
+ * [TensorFlow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~31-~31: There might be a mistake here. (QB_NEW_EN) 🤖 Prompt for AI Agents |
||||||
| * [Manage NLU Entities](user-guide/nlu/manage-nlu-entities.md) | ||||||
| * [NLU Match Scoring](user-guide/nlu/nlu-match-scoring.md) | ||||||
| * [NLU Training](user-guide/nlu-training.md) | ||||||
| * [Knowledge Base](user-guide/knowledge-base/README.md) | ||||||
| * [Content Types](user-guide/knowledge-base/content-types.md) | ||||||
| * [Manage Persistent Menu](user-guide/knowledge-base/manage-persistent-menu.md) | ||||||
| * [Media Library](user-guide/knowledge-base/media-library.md) | ||||||
| * [Localization](user-guide/localization/README.md) | ||||||
| * [Languages](user-guide/localization/languages.md) | ||||||
| * [Translations](user-guide/localization/translations.md) | ||||||
| * [Users and Roles](user-guide/users-and-roles/README.md) | ||||||
| * [Manage users](user-guide/users-and-roles/manage-users.md) | ||||||
| * [Manage roles](user-guide/users-and-roles/manage-roles.md) | ||||||
| * [Manage Settings](user-guide/manage-settings/README.md) | ||||||
| * [Email](user-guide/manage-settings/email.md) | ||||||
| * [Chatbot Global Fallback](user-guide/manage-settings/chatbot-global-fallback.md) | ||||||
| * [NLU Provider](user-guide/manage-settings/nlu-provider.md) | ||||||
| * [Web Channel](user-guide/manage-settings/web-channel.md) | ||||||
| * [Live chat widget](user-guide/manage-settings/live-chat-widget.md) | ||||||
| * [Facebook Messenger](user-guide/manage-settings/facebook-messenger.md) | ||||||
| * [Context Variables](user-guide/context-variables.md) | ||||||
| * [Chat Inbox](user-guide/chat-inbox.md) | ||||||
| * [Subscribers](user-guide/subscribers.md) | ||||||
| * [Analytics Dashboard](user-guide/analytics-dashboard.md) | ||||||
|
|
||||||
| ## FAQ | ||||||
|
|
||||||
| * [How can I deploy my Hexabot using NGINX ?](faq/how-can-i-deploy-my-hexabot-using-nginx.md) | ||||||
| * [How can I add the Chatbot Widget to my Website?](faq/how-can-i-add-the-chatbot-widget-to-my-website.md) | ||||||
medchedli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Developer Guide | ||||||
|
|
||||||
| * [Contributors Installation Guide](developer-guide/contributors-installation-guide.md) | ||||||
| * [CLI Command Reference](developer-guide/cli-command-reference.md) | ||||||
| * [Setup Node.js with NVM](developer-guide/setup-node.js-with-nvm.md) | ||||||
| * [Setting Up Docker for Development and Production](developer-guide/setting-up-docker-for-development-and-production.md) | ||||||
| * [SMTP Configuration and Emails](developer-guide/smtp-configuration-and-emails.md) | ||||||
| * [Extensions](developer-guide/extensions.md) | ||||||
| * [Plugins](developer-guide/integrations/README.md) | ||||||
| * [Hexabot Plugin Development](developer-guide/integrations/hexabot-plugin-development.md) | ||||||
| * [Build your First Plugin](developer-guide/integrations/build-your-first-plugin.md) | ||||||
| * [Hexabot NLU Engine](developer-guide/hexabot-nlu-engine.md) | ||||||
| * [Training custom NLU Models with Ludwig AI](developer-guide/training-custom-nlu-models-with-ludwig-ai.md) | ||||||
|
|
||||||
| ## Key Concepts | ||||||
|
|
||||||
| * [NLU](key-concepts/nlu.md) | ||||||
| * [Intent](key-concepts/intent.md) | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| --- | ||
| icon: rectangle-terminal | ||
| --- | ||
|
|
||
| # CLI Command Reference | ||
|
|
||
| Hexabot CLI is a powerful command-line tool to help manage your Hexabot chatbot instance. With it, you can create new projects, initialize environments, start services in various modes, run database migrations, and more. The CLI aims to make managing your chatbot seamless and intuitive. | ||
|
|
||
| Not yet familiar with [Hexabot](https://hexabot.ai/)? It's a open-source chatbot / agent solution that allows users to create and manage AI-powered, multi-channel, and multilingual chatbots with ease. If you would like to learn more, please visit the [official github repo](https://github.com/Hexastack/Hexabot/). | ||
|
|
||
| ### Getting Started | ||
|
|
||
| #### Prerequisites | ||
|
|
||
| * Node.js >= 18.17.0 | ||
| * npm (Node Package Manager) | ||
| * Docker installed | ||
|
|
||
| #### Installation | ||
|
|
||
| Install Hexabot CLI globally to have easy access to its commands: | ||
|
|
||
| ``` | ||
| npm install -g hexabot-cli | ||
| ``` | ||
|
|
||
| #### Usage | ||
|
|
||
| Once installed, you can use the `hexabot` command in your terminal. Here are some of the available commands: | ||
|
|
||
| #### Commands | ||
|
|
||
| **`create <projectName>`** | ||
|
|
||
| Create a new Hexabot project. | ||
|
|
||
| ``` | ||
| hexabot create my-chatbot | ||
| ``` | ||
|
|
||
| Options: | ||
|
|
||
| * `--template <template>`: Specify a GitHub repository in the format `GITHUB_USERNAME/GITHUB_REPO` to use a custom template. | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| hexabot create my-chatbot --template myusername/my-template-repo | ||
| ``` | ||
|
|
||
| **`init`** | ||
|
|
||
| Initialize the environment by copying `.env.example` to `.env`. | ||
|
|
||
| ``` | ||
| hexabot init | ||
| ``` | ||
|
|
||
| **`dev`** | ||
|
|
||
| Start specified services in development mode with Docker Compose. | ||
|
|
||
| ``` | ||
| hexabot dev --services nlu,ollama | ||
| ``` | ||
|
|
||
| Options: | ||
|
|
||
| * `--services <services>`: Comma-separated list of services to enable. | ||
|
|
||
| **`start`** | ||
|
|
||
| Start specified services with Docker Compose. | ||
|
|
||
| ``` | ||
| hexabot start --services api,nlu | ||
| ``` | ||
|
|
||
| Options: | ||
|
|
||
| * `--services <services>`: Comma-separated list of services to enable. | ||
|
|
||
| **`migrate [args...]`** | ||
|
|
||
| Run database migrations. | ||
|
|
||
| ``` | ||
| hexabot migrate | ||
| ``` | ||
|
|
||
| You can also pass additional arguments to the migration command. | ||
|
|
||
| **`start-prod`** | ||
|
|
||
|
|
||
|
|
||
| Start specified services in production mode with Docker Compose. | ||
|
|
||
| ``` | ||
| hexabot start-prod --services api,nlu | ||
| ``` | ||
|
|
||
| Options: | ||
|
|
||
| * `--services <services>`: Comma-separated list of services to enable. | ||
|
|
||
| **`stop`** | ||
|
|
||
| Stop specified Docker Compose services. | ||
|
|
||
| ``` | ||
| hexabot stop --services api,nlu | ||
| ``` | ||
|
|
||
| Options: | ||
|
|
||
| * `--services <services>`: Comma-separated list of services to stop. | ||
|
|
||
| **`destroy`** | ||
|
|
||
| Destroy specified Docker Compose services and remove volumes. | ||
|
|
||
| ``` | ||
| hexabot destroy --services api,nlu | ||
| ``` | ||
|
|
||
| Options: | ||
|
|
||
| * `--services <services>`: Comma-separated list of services to destroy. | ||
|
|
||
| ### Example Workflow | ||
|
|
||
| 1. **Create a new project**: | ||
|
|
||
| ``` | ||
| hexabot create my-chatbot | ||
| ``` | ||
|
|
||
| This will create a new folder `my-chatbot` with all necessary files to get started. | ||
| 2. **Navigate to your project folder**: | ||
|
|
||
| ``` | ||
| cd my-chatbot | ||
| ``` | ||
| 3. **Install dependencies**: | ||
|
|
||
| ``` | ||
| npm install | ||
| ``` | ||
| 4. **Initialize environment**: | ||
|
|
||
| ``` | ||
| hexabot init | ||
| ``` | ||
|
|
||
| This command copies the `.env.example` file to `.env`, which you can edit to customize your configuration. | ||
| 5. **Run in development mode**: | ||
|
|
||
| ``` | ||
| hexabot dev --services nlu,ollama | ||
| ``` | ||
|
|
||
| This starts the required services in development mode. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Automate link validation for docs.
Add a quick link-check to CI to prevent regressions.
🏁 Script executed:
Length of output: 35620
Fix broken documentation links and add CI link-validation step.
broken-reference) before merging.🤖 Prompt for AI Agents
Replace “Broken link” placeholders with real targets.
Broken links on the homepage harm navigation.
If these exact targets differ in your repo, adjust accordingly.
📝 Committable suggestion
🤖 Prompt for AI Agents