diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index bd33b8a5..e5f624fe 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -52,6 +52,7 @@ ## Developer Guide +* [CLI Command Reference](developer-guide/cli-command-reference.md) * [Developers Installation Guide](developer-guide/developers-installation-guide.md) * [Hexabot UI Admin Panel](developer-guide/hexabot-ui-admin-panel.md) * [Hexabot Live Chat Widget](developer-guide/hexabot-live-chat-widget.md) diff --git a/docs/developer-guide/cli-command-reference.md b/docs/developer-guide/cli-command-reference.md new file mode 100644 index 00000000..6a9de8d2 --- /dev/null +++ b/docs/developer-guide/cli-command-reference.md @@ -0,0 +1,159 @@ +# 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 `** + +Create a new Hexabot project. + +``` +hexabot create my-chatbot +``` + +Options: + +* `--template