BBai has a new home: https://github.com/Beyond-Better/bb
BBai (pronounced b-b-aye) is an advanced AI-powered assistant designed to revolutionize how you work with text-based projects. Whether you're coding, writing, or managing complex documentation, BBai is here to help you "be better" at every step.
(The name BBai is also a respectful nod to BBEdit, my beloved text editor by Bare Bones Software)
- Project Status: Beta
- Why BBai?
- Who Can Benefit from BBai?
- Use Cases
- How BBai Works
- Getting Started
- Documentation
- Why Choose BBai?
- Roadmap
- Join the BBai Community
- Project Links
BBai is currently in beta stage of development. While we're excited about its potential, please be aware that you may encounter bugs or incomplete features. We're actively working on improvements and new functionalities.
We're Seeking Testers and Contributors! If you're interested in being part of the BBai journey, we'd love to hear from you. Whether you want to test the tool, contribute code, or share ideas, please reach out. Your input can help shape the future of BBai.
To get involved, please submit an issue, or contact me directly.
In a world where AI assistants are becoming commonplace, BBai stands out by offering a more comprehensive, project-wide approach to content creation and management. Born from the need for a more versatile and powerful tool than existing solutions, BBai brings the full potential of large language models (LLMs) directly to your projects.
- Universal Text Support: From code to prose, BBai handles it all.
- First-Class Project Discussions: Makes conversations about your project as important as the changes themselves.
- Conversation Management: Handles multiple conversations simultaneously for complex projects.
- Intelligent Tools: Employs LLM tools for clear, purpose-driven interactions.
- Web Page Fetching: The
FetchWebPagetool allows BBai to retrieve content from web pages, providing additional context and information for the LLM to reference during conversations. - Web Page Screenshot: The
FetchWebScreenshottool enables BBai to capture screenshots of web pages, allowing the LLM to analyze visual content when needed. - Project-Wide Understanding: Uses
ctagsfor initial project comprehension, with plans for advanced techniques like RAG and embeddings in the future. - Multiple Interface Options: API, Browser User Interface (BUI), Command Line Interface (CLI), and future Desktop User Interface (DUI) for flexible usage.
BBai is designed for a wide range of professionals working with text, including but not limited to:
- Software Developers
- Technical Writers
- Content Creators
- Fiction Authors
- Data Scientists
- Configuration Managers
BBai excels in various scenarios:
- Code Refactoring: Analyze and improve code across an entire project.
- Documentation Updates: Keep your docs in sync with code changes.
- Content Creation: Generate and refine written content with AI assistance.
- Project Analysis: Get insights and summaries of large codebases or text projects.
- Learning and Exploration: Discuss and understand complex projects with an AI assistant.
- Project Understanding: BBai uses advanced techniques to comprehend your entire project.
- Intelligent Conversations: Discuss your project, ask questions, and explore ideas with the AI.
- Coherent Changes: Make wide-ranging, consistent updates across your project with ease.
- Review and Iterate: Analyze changes, discuss further improvements, and refine your work.
Before using BBai, ensure you have the following:
- An Anthropic API key (Note: This is different from your Anthropic chat console login. You'll need to create an API key at https://console.anthropic.com/settings/keys)
- Git (latest stable version, recommended but optional)
- ctags (optional, enhances project understanding)
- Either
mkcertoropensslfor TLS certificate generation (required for proper operation)
To install mkcert:
- On Windows:
choco install mkcert - On macOS:
brew install mkcert - On Linux: Follow the instructions at https://github.com/FiloSottile/mkcert#linux
Note for technical users: Any valid TLS certificate can be used. BBai provides four config options for custom certificates: api.tlsKeyFile, api.tlsCertFile, api.tlsKeyPem, api.tlsCertPem. Use either file paths or inlined PEM content, not both.
Git, ctags, and mkcert can be easily installed using package managers like Homebrew on macOS, Chocolatey on Windows, or apt on Linux. While Git is optional, it's highly recommended for optimal use of BBai. TLS certificates are required for proper operation, and will be automatically generated during the initialization process if not provided.
BBai can be installed on various platforms:
-
macOS and Linux: Use our one-line installation script:
curl -sSL https://raw.githubusercontent.com/BBai-Tips/bbai/main/install.sh | sh -
Windows: Download and run the
bbai-installer.msifrom our Releases page. For detailed instructions, see our Windows User Guide. -
Manual Installation: For advanced users, we provide options to install from release packages or build from source.
For detailed installation instructions, please refer to our Installation Guide.
After installation, you can start using BBai as follows:
- Initialize BBai in your project directory:
bbai init - Start the BBai API and open the browser interface:
bbai start - Or, start the BBai API and use the command-line interface:
bbai chat
On Windows, use bbai.exe instead of bbai.
For detailed information on how to use BBai, please refer to our documentation:
- API Documentation: Explore the BBai API endpoints for integrating BBai into your workflows or building custom tools.
- BUI Documentation: Learn about the planned Browser User Interface for BBai.
- CLI Documentation: Understand how to use the BBai Command Line Interface for various operations.
- DUI Documentation: Explore the future plans for the Desktop User Interface.
These guides provide comprehensive information on BBai's features, usage patterns, and best practices to help you make the most of this powerful tool.
- Holistic Approach: Unlike auto-complete tools, BBai understands and reasons over your entire project.
- Versatility: Works with any text-based project, not just code.
- Efficiency: Streamlines the process of making large-scale, coherent changes.
- Learning Tool: Enhances understanding of complex projects through AI-assisted exploration.
- Future-Proof: Designed to grow with advancements in AI and LLM technology.
BBai is continuously evolving. Here's an overview of our planned features and approximate timelines:
- Short-term (Next 3-6 months):
- Implementation of RAG and embedding capabilities for enhanced project understanding and comprehensive project visibility
- Initial support for additional LLM providers
- Medium-term (6-12 months):
- Agent Orchestrator: A powerful feature that allows the LLM to break down complex tasks into smaller chunks managed by sub-agents. This enables:
- Faster and more cost-effective processing for simple tasks using smaller models
- Reduced context window size and costs for multiple conversations
- Synchronous task completion for improved overall operation speed
- Expanded tool ecosystem for more specialized tasks
- Long-term (Beyond 12 months):
- Advanced integration with version control systems
- Collaborative features for team-based projects
- AI-driven project optimization suggestions
Please note that these timelines are approximate and subject to change based on development progress and community feedback.
BBai is more than just a tool; it's a growing community of professionals pushing the boundaries of what's possible with AI-assisted work. Whether you're a seasoned developer or a curious writer, BBai is here to help you be better at what you do.
Start your journey with BBai today and transform the way you work with text!
BBai: Be Better at ... Everything You Do with Text
BBai is designed to work on the following operating systems:
- macOS (10.15 Catalina and later)
- Linux (major distributions like Ubuntu, Fedora, CentOS)
- Windows 10 and later
It's compatible with projects using various programming languages and text-based formats.
We value your input and are here to help you get the most out of BBai:
- For bug reports or feature requests, please open an issue on our GitHub repository.
- For general questions or discussions, join our community forum.
- For more immediate support, reach out to us via email at support@bbai.tips.
Your feedback is crucial in shaping the future of BBai!