Documentation

Everything you need to know about using BB, the intelligent assistant from Beyond Better.

Overview

BB is an intelligent assistant designed by Beyond Better to revolutionize how you work with text-based projects. Whether you're coding, writing, or managing complex documentation, BB helps you achieve better results at every step.

This documentation will guide you through getting started with BB, exploring its features, and integrating it into your workflow.

Installation

BB can be installed on macOS, Linux, and Windows systems. For detailed installation instructions, visit our Installation Guide.

Usage

After installation, you can use BB through its Command Line Interface (CLI) or by starting the API server and using the browser interface.

What to Expect

BB works incrementally, making small changes and verifying results as it goes. This is normal and ensures accuracy. You'll see multiple tool operations as BB:

  • Analyzes files and makes changes
  • Verifies changes and adjusts as needed
  • Keeps you informed of progress

Learn more about BB's behavior in our Understanding BB guide, or dive into the technical details.

For detailed usage instructions, check out our CLI Documentation.

API Integration

BB provides a powerful API for integration with other tools and workflows. For detailed API documentation, refer to our API Documentation.

Windows Users

For Windows users, we provide specific instructions and tools to make using BB easier. Check out our Windows User Guide.

Contributing

We welcome contributions to BB! If you're interested in contributing, please read our Contributing Guidelines and Code of Conduct.