{"id":17873784,"url":"https://github.com/hexastack/hexabot-cli","last_synced_at":"2026-02-18T10:02:38.461Z","repository":{"id":259762670,"uuid":"879369630","full_name":"Hexastack/hexabot-cli","owner":"Hexastack","description":"CLI for Hexabot to create projects and run them.","archived":false,"fork":false,"pushed_at":"2025-01-30T17:10:49.000Z","size":95,"stargazers_count":1,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T03:11:33.233Z","etag":null,"topics":["agent","ai","artificial-intelligence","chatbot","chatbot-application","chatbot-development","chatbot-framework","chatbots","chatgpt","cli","conversational-ai","gemini","hexabot","llama","llm","llms","local-ai","mistral","ollama","text-to-action"],"latest_commit_sha":null,"homepage":"https://docs.hexabot.ai","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hexastack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-27T18:12:28.000Z","updated_at":"2025-01-30T17:10:53.000Z","dependencies_parsed_at":"2024-10-27T22:28:21.360Z","dependency_job_id":"c79aa974-c187-4926-89e7-03d1c2c35ede","html_url":"https://github.com/Hexastack/hexabot-cli","commit_stats":null,"previous_names":["hexastack/hexabot-cli"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hexastack%2Fhexabot-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hexastack%2Fhexabot-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hexastack%2Fhexabot-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hexastack%2Fhexabot-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hexastack","download_url":"https://codeload.github.com/Hexastack/hexabot-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250507511,"owners_count":21442010,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","ai","artificial-intelligence","chatbot","chatbot-application","chatbot-development","chatbot-framework","chatbots","chatgpt","cli","conversational-ai","gemini","hexabot","llama","llm","llms","local-ai","mistral","ollama","text-to-action"],"created_at":"2024-10-28T11:05:05.878Z","updated_at":"2026-02-18T10:02:38.449Z","avatar_url":"https://github.com/Hexastack.png","language":"JavaScript","readme":"# Hexabot CLI\n\nHexabot 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.\n\n\nNot 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/).\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js \u003e= 18.17.0\n- npm (Node Package Manager)\n- Docker installed\n\n### Installation\n\nInstall Hexabot CLI globally to have easy access to its commands:\n\n```sh\nnpm install -g hexabot-cli\n```\n\n### Usage\n\nOnce installed, you can use the `hexabot` command in your terminal. Here are some of the available commands:\n\n### Commands\n\n#### `create \u003cprojectName\u003e`\n\nCreate a new Hexabot project.\n\n```sh\nhexabot create my-chatbot\n```\n\nOptions:\n\n- `--template \u003ctemplate\u003e`: Specify a GitHub repository in the format `GITHUB_USERNAME/GITHUB_REPO` to use a custom template.\n\nExample:\n\n```sh\nhexabot create my-chatbot --template myusername/my-template-repo\n```\n\n#### `init`\n\nInitialize the environment by copying `.env.example` to `.env`.\n\n```sh\nhexabot init\n```\n\n#### `dev`\n\nStart specified services in development mode with Docker Compose.\n\n```sh\nhexabot dev --services nlu,ollama\n```\n\nOptions:\n\n- `--services \u003cservices\u003e`: Comma-separated list of services to enable.\n\n\n#### `start`\n\nStart specified services with Docker Compose.\n\n```sh\nhexabot start --services api,nlu\n```\n\nOptions:\n\n- `--services \u003cservices\u003e`: Comma-separated list of services to enable.\n\n\n#### `migrate [args...]`\n\nRun database migrations.\n\n```sh\nhexabot migrate\n```\n\nYou can also pass additional arguments to the migration command.\n\n#### `start-prod`\n\nStart specified services in production mode with Docker Compose.\n\n```sh\nhexabot start-prod --services api,nlu\n```\n\nOptions:\n\n- `--services \u003cservices\u003e`: Comma-separated list of services to enable.\n\n#### `stop`\n\nStop specified Docker Compose services.\n\n```sh\nhexabot stop --services api,nlu\n```\n\nOptions:\n\n- `--services \u003cservices\u003e`: Comma-separated list of services to stop.\n\n#### `destroy`\n\nDestroy specified Docker Compose services and remove volumes.\n\n```sh\nhexabot destroy --services api,nlu\n```\n\nOptions:\n\n- `--services \u003cservices\u003e`: Comma-separated list of services to destroy.\n\n## Example Workflow\n\n1. **Create a new project**:\n\n   ```sh\n   hexabot create my-chatbot\n   ```\n\n   This will create a new folder `my-chatbot` with all necessary files to get started.\n\n2. **Navigate to your project folder**:\n\n   ```sh\n   cd my-chatbot\n   ```\n\n3. **Install dependencies**:\n\n   ```sh\n   npm install\n   ```\n\n4. **Initialize environment**:\n\n   ```sh\n   hexabot init\n   ```\n\n   This command copies the `.env.example` file to `.env`, which you can edit to customize your configuration.\n\n5. **Run in development mode**:\n\n   ```sh\n   hexabot dev --services nlu,ollama\n   ```\n\n   This starts the required services in development mode.\n\n## Documentation\n\nFor detailed information on how to get started, as well as in-depth user and developer guides, please refer to our full documentation available in the docs folder or visit the [Documentation](https://docs.hexabot.ai).\n\nYou can also find specific documentation for different components of the project in the following locations:\n\n- [API Documentation](api/README.md)\n- [UI Documentation](frontend/README.md)\n- [Live Chat Widget Documentation](widget/README.md)\n- [NLU Engine Documentation](nlu/README.md)\n\n## Contributing\n\nWe welcome contributions from the community! Whether you want to report a bug, suggest new features, or submit a pull request, your input is valuable to us.\n\nPlease refer to our contribution policy first : [How to contribute to Hexabot](./CONTRIBUTING.md)\n\n\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./CODE_OF_CONDUCT.md)\n\nFeel free to join us on [Discord](https://discord.gg/rNb9t2MFkG)\n\n## License\n\nThis software is licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:\n\n1. The name \"Hexabot\" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.\n2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's \"About\" section, documentation, and README file).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhexastack%2Fhexabot-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhexastack%2Fhexabot-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhexastack%2Fhexabot-cli/lists"}