BotifyMe CLI

Welcome to the BotifyMe CLI! This tool is designed to streamline the development of multi-agent workflows by providing a robust local development environment that mirrors the BotifyMe platform. Whether you are developing complex systems or simple automated tasks, the BotifyMe CLI offers a comprehensive suite of features to help you from development to deployment. With this CLI, you can manage your project's lifecycle, execute in isolated sandboxes, and leverage advanced debugging tools to build efficient and reliable agents.

Install

To begin developing with BotifyMe locally, install the CLI. This setup prepares your local environment, establishes necessary sandboxes for safe tool execution, and initiates a local development dashboard featuring tracing and API documentation.

Execute the following command to install:

curl -L  https://raw.githubusercontent.com/botifyme/cli/main/install.sh | sh
Copy code

Running BotifyMe in the local environment

BotifyMe relies on Docker containers to manage local development environments. Ensure you install and test Docker on your machine as a first step:

• Install Docker
• Docker Desktop

To create a new project, navigate to the desired directory and run:

botifyme init
Copy code

This command generates a botifyme.yml configuration file in your project directory. You can safely commit this directory to your version control system. For more details on the configuration schema, visit the Configuration Schema Documentation.

To launch the BotifyMe local environment, execute:

botifyme dev up
Copy code

This command reads the configuration file, builds sandbox environments, and constructs the required Docker images. Note that downloading Docker images depends on your internet bandwidth and may take longer during the initial setup.

To shut down the local BotifyMe environment when your work is complete, use:

botifyme dev down
Copy code