Commbase is a flexible and extensible ✨ development framework ✨ designed to empower computers and other devices with cutting-edge conversational AI capabilities. It serves as both a module and library bundler, incorporating third-party LLMs to enable features such as "distributed AIs" or "multi-agent systems" (MAS). Commbase adapts across a diverse range of devices, from computers to robots, smart appliances, vehicles, Iron Man like suits, starships, and beyond, ensuring universal accessibility and functionality. Operating effortlessly on either a single machine or a pair of machines in a client-server architecture, Commbase offers unparalleled adaptability and scalability.
| Topic | Features |
|---|---|
| 🛠️ Installation & Setup | * Detailed installation steps, structure, and contribution guidelines are available on the GitHub repository, ensuring secure and transparent setup processes. |
| 💻 Commands & Interfaces | * Help option to see available built-in commands for terminal use or development. * Built-in commands support both voice and terminal command calls. |
| ⚙️ Control & Accessibility | * Easy to start and stop using init systems, cron jobs, terminal commands, or voice commands. * Terminal-based interface, with the option to create custom UIs. |
| 🔀 Navigation | * Seamlessly switch among windows using keybindings to access dashboards, server connections, etc. |
| 🖥️ Multi-pane Support | * Multiple panes are provided, covering functionalities like the chat room, STT engine (Speech-to-Text), server pane, client pane, and additional options. |
| 📂 Custom Applications | * Load custom terminal applications and seamlessly switch back to the chat room in the same pane. |
| 🎨 Personalization | * Customizable application, user, and assistant names. |
| 📝 Logging & Recording | * Terminal and voice command recorder-transmitter area easy to install even in other hosts for remote control through networks, with enabled secure access control and logging. |
| 🔧 Configuration | * Effortlessly adjust and customize your settings with our platform's centralized configuration files. No code is required to configure built-in options. |
| 🗣️ STT & TTS Engines | * The STT Engine operates in Whisper reactive mode by default, with the ability to switch to Whisper proactive mode at any time. * TTS Engines are dedicated for text-to-speech functionalities, so projects can effectively speak in various languages, enhancing accessibility and global reach. |
| 🌍 Internationalization | * Support to global audiences with seamless internationalization. * Tailor your user experience by modifying i18n files to customize voice commands. |
| 📜 Custom Scripting | * Effortlessly create custom server-side command scripts with a single file catalog database (scalable to any RDBMS), our up-to-date well-documented API, and JSON simplicity. * Write command scripts in any programming language. |
| ♻️ Reusable Functions | * Access to a comprehensive library of reusable functions to enhance custom command scripts with streamlined efficiency and tailored functionalities. |
| 🤖 Advanced Capabilities | * LLMs (Large Language Models) integration. * Enhanced assistant capabilities with advanced language understanding, including additional features like vision. |
| 📊 Activity Management | * Efficiently manage your system's activity and user interactions by seamlessly integrating Commbase logs with custom app logs. * Logs include customizable backups of past assistant-user conversations. |
| 🛡️ Platform Stability | * The use of Linux enhances the stability, reliability, and security of our software, ensuring robust and flexible performance in various environments. |
INSTALL Commbase and then run the next command in a terminal to start the program:
commbase start
Commbase will be ready to receive Commbase voice commands and Commbase terminal commands to assist you.
For more terminal options, run:
commbase -h
Check out the User's Guide for a complete list of options.
For information on how to install Commbase, follow the steps in the file INSTALL.
For information on how to set up, use, and program Commbase read the User's Guide.
This project is coded and organized like this:
/path/to/my/commbase/app
├── assets # Stores different types of assets, such as images, fonts, and ASCII art
│ ├── ascii
│ ├── docs # Stores the Commbase User's Guide
│ │ └── images
│ ├── fonts
│ ├── icons
│ └── images
├── bundles # External software bundle and external asset bundle
│ ├── commbase-data-exchange
│ │ ├── client
│ │ │ └── templates
│ │ └── server
│ │ ├── client_data
│ │ └── templates
│ ├── commbase-llm-google-gemini-p
│ ├── commbase-llm-meta-llama-p
│ ├── commbase-llm-openai-gpt-p
│ ├── commbase-recorder-transmitter-b
│ ├── commbase-recorder-transmitter-s
│ ├── commbase-stt-whisper-proactive-p
│ │ └── examples
│ ├── commbase-stt-whisper-reactive-p
│ │ ├── client_data
│ │ └── examples
│ ├── commbase-tts-gTTS
│ ├── commbase-tts-pyttsx3
│ └── libcommbase
│ ├── examples
│ ├── libcommbase
│ │ ├── interactive
│ │ └── routines
│ └── resources
│ ├── bundles
│ │ └── sounds
│ └── i18n
│ ├── control_patterns
│ │ └── openai_whisper_models
│ │ ├── base
│ │ └── ...
│ ├── discourses
│ ├── log_messages
│ └── skill_patterns
│ └── openai_whisper_models
│ ├── base
│ └── ...
├── certificates # Stores the security certificates
├── config # Stores the configuration file
├── data # Stores the voice recognition model results and other data files
├── env # Stores the environment file
├── history # Stores the Commbase commands history
├── i18n # Stores resources related to localization and internationalization
│ ├── discourses
│ └── log_messages
├── log # Stores the log messages
├── screenshots # Stores the image commbase.png
├── scripts # Stores the scripts for deploying and configuring Commbase, and a few utils
│ ├── configuration
│ │ ├── install_commbase_executable
│ │ └── reset_commbase.conf
│ ├── deployment
│ └── utilities
│ ├── back-up
│ └── bundles
│ └── vu-meter
├── src # This directory contains user-generated source code
│ ├── client
│ │ ├── assets # Stores different types of assets, such as images, fonts, and ASCII art
│ │ │ ├── ascii
│ │ │ └── docs # Stores your app User's Guide
│ │ ├── bundles
│ │ │ ├── audiobooks
│ │ │ │ └── Robinson_Crusoe
│ │ │ └── ...
│ │ ├── config
│ │ ├── i18n
│ │ │ ├── discourses
│ │ │ ├── log_messages
│ │ │ └── skill_patterns
│ │ │ └── openai_whisper_models
│ │ │ ├── base
│ │ │ └── ...
│ │ ├── log
│ │ └── serial_communication
│ │ ├── arduino
│ │ │ ├── arduino_0
│ │ │ │ ├── commbase_hardware_notifications
│ │ │ │ │ ├── speech_to_text_engine_component
│ │ │ │ │ └── ...
│ │ │ │ └── ...
│ │ │ └── ...
│ │ └── ...
│ ├── server
│ │ └── skills_db
│ │ ├── arduino
│ │ ├── bash
│ │ │ └── f
│ │ │ ├── firefox
│ │ │ └── ...
│ │ ├── c++
│ │ ├── java
│ │ ├── multi-lang
│ │ ├── nodejs
│ │ ├── python
│ │ ├── rust
│ │ └── ...
│ └── tests
├── tests # Stores the Commbase tests
└── user # Stores previous chat conversations and other user files
├── analysis_zone
└── conversation_logsOur software embodies the minimalism and DRY (Don't Repeat Yourself) Unix philosophies, ensuring streamlined features and avoiding unnecessary repetition for enhanced efficiency and simplicity.
The open-source nature of our project empowers developers to extend its capabilities by adding more bundles or writing their own code, fostering a collaborative and adaptable environment beyond voice commands.
Additionally, our modular design facilitates flexible customization and extension of functionalities according to user needs.
We adhere to industry-standard best practices in software engineering for design and architecture, ensuring the development of robust, scalable, and maintainable systems that meet the highest quality standards and user expectations.
Moreover, you can incorporate your unique serial and wireless hardware into our platform, enabling tailored communication and interaction with devices, enhancing versatility and functionality.
To contribute to Commbase, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m '<commit_message>' - Push to the original branch:
git push origin <project_name>/<location> - Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
Thanks to the following people who have contributed to this project:
If you want to contact us you can reach us at [email protected].
This project uses the following license: License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent