/crews-control

Crews Control is an abstraction layer on top of crewAI, designed to facilitate the creation and execution of AI-driven projects without writing code. By defining an execution.yaml file, users can orchestrate AI crews to accomplish complex tasks using predefined or custom tools.

Primary LanguagePythonMIT LicenseMIT

Crews Control

Acknowledgements

This project builds upon the following MIT-licensed project:

Crews Control is an abstraction layer on top of crewAI, designed to facilitate the creation and execution of AI-driven projects without writing code. By defining an execution.yaml file, users can orchestrate AI crews to accomplish complex tasks using predefined or custom tools.

Features

  • No-Code AI Orchestration: Define projects with execution.yaml, specifying crews, agents, and tasks.
  • Modular Tools: Use a set of predefined tools or create custom ones.
  • Artifact Generation: Each crew outputs a file artifact from the final task.
  • Templated Outputs: Access outputs from previous crews’ tasks using a templating syntax.

Licensing

This repository includes the following files which are licensed under the GNU General Public License (GPL) Version 3:

  • requirements.in
  • requirements.txt

The rest of the repository is licensed under the MIT License, which can be found in the LICENSE file.

Legal Disclaimer

This project and all information herein is provided “as-is” without any warranties or representations. Axonius relies on licenses published by third parties for dependencies and background for this project and therefore does not warrant that the licenses presented herein are correct. Licensees should perform their own assessment before using this project.

Main Project (MIT License)

All files in this repository, except for the requirements.in and requirements.txt files, are licensed under the MIT License. You can find the full text of the MIT License in the LICENSE file.

Requirements Files (GPL License)

The requirements.in and requirements.txt files, which list the dependencies required to run this project, are licensed under the GNU General Public License (GPL). You can find the full text of the GPL in the LICENSE-REQUIREMENTS file.

Prerequisites

  1. Python 3.12 (may work with other versions. Untested)

  2. Docker (optional) - to run dockerized version.

  3. Environment variables listed in .env.example

Environment Setup

The project requires certain environment variables to function correctly. These variables are listed in the .env.example file. To configure these variables, follow these steps:

  1. Copy the .env.example file and rename the copy to .env:
cp .env.example .env
  1. Open the newly created .env file and fill in the relevant values for each environment variable. These variables include API keys and other configuration settings necessary for the project's operation.

Note: Some environment variables may not be relevant to your specific use case. For example, if you don't need to create Jira tickets, you may not have a Jira server and therefore won't have Jira-related credentials. In such cases, fill in placeholder values to ensure the project functions correctly.

Make sure to keep this .env file secure and do not expose it publicly, as it contains sensitive information.

Installation

Mac / Linux

  1. Clone the repository:
git clone https://github.com/Axonius/crews-control.git
cd crews-control
  1. Create a virtual environment
python -m venv .venv
source .venv/bin/activate
  1. Compile requirements.txt file (optional)
pip install pip-tools
pip-compile --generate-hashes requirements.in
  1. Install the dependencies:
pip install setuptools
pip install --require-hashes --no-cache-dir -r requirements.txt

Usage

Run a project (interactive-mode):

make run_it project_name=<PROJECT_TO_RUN>

Run a project (cli-mode):

python crews_control.py --project-name=<PROJECT_TO_RUN> --params input1="value 1" input2="value 2" ... inputN="value N"

Example - run the pr-security-review project to review PR #1 of the Axonius/crews-control GitHub repository:

python crews_control.py --project-name pr-security-review --params github_repo_name="Axonius/crews-control" pr_number="1"

Windows

Coming soon...

Docker (tested on MacOS only)

  1. Clone the repository:
git clone https://github.com/Axonius/crews-control.git
cd crews-control
  1. Compile requirements.txt file (optional)
make compile-requirements
  1. Build the Crews-Control Docker image
make build

Usage

Run a project (interactive-mode):

make run_it project_name=<PROJECT_TO_RUN>

Run a project (cli-mode):

make run project_name=<PROJECT_TO_RUN> PARAMS="<input1='value 1' input2='value 2' ... inputN='value N'>"

Example - run the pr-security-review project to review PR #1 of the Axonius/crews-control GitHub repository:

make run project_name=pr-security-review PARAMS="github_repo_name='Axonius/crews-control' pr_number='1'"

Creating a Project

  1. Create a subfolder projects/project_name.
  2. Inside the subfolder, create a file name execution.yaml. The file shall have the following structure:
settings:
  output_results: true

user_inputs:
  user_input_1:
    title: "User input 1"

  user_input_2:
    title: "User input 2"

  optional_user_input_3:
    optional: true
    title: "Optional user input 3"

crews:
  some_crew:
    # can use values from user input as part of the output filename, backstory and task description
    output_naming_template: 'output_some_crew_filename_{user_input_1}_{user_input_2}.md'
    agents:
      some_agent:
        role: "Some Agent"
        goal: "Sample Goal based on {user_input_1} and {user_input_2}."
        tools:
          - human
        backstory: >
          This agent is a sample placeholder designed to demonstrate how AI can process and analyze data based on {user_input_1}.
        The sample data processor illustrates the capabilities of AI without being tied to a specific field.
        This placeholder can be replaced with a real agent tailored to specific project needs.    
    tasks:
      research:
        agent: some_agent
        tools:
          - human
        description: >
          This is a sample placeholder for description of a task that will be performed by some_agent.
          You can reference {user_input_1}, {user_input_2} and {optional_user_input_3}.
        expected_output: >
          This is a sample placeholder for the exected output of the sample task. You can also reference {user_input_1},
          {user_input_2} and {optional_user_input_3} here.

  some_other_crew:
    depends_on:
      - some_crew
    # can use values from user input as part of the output filename, backstory and task description
    output_naming_template: 'output_some_other_crew_filename_{user_input_1}_{user_input_2}.md'
    agents:
      some_agent:
        role: "Some Agent"
        goal: "Sample Goal based on {user_input_1} and {user_input_2}."
        tools:
          - human
        backstory: >
          This agent is a sample placeholder designed to demonstrate how AI can process and analyze data based on {user_input_1}.
        The sample data processor illustrates the capabilities of AI without being tied to a specific field.
        This placeholder can be replaced with a real agent tailored to specific project needs.    
    tasks:
      research:
        agent: some_agent
        tools:
          - human
        description: >
          This is a sample placeholder for description of a task that will be performed by some_agent.
          You can reference {user_input_1}, {user_input_2} and {optional_user_input_3}.

          You can also reference a dependant crew's final output like this: {some_agent}. The content of the last task of the
          referenced crew will be placed verbatim inline.
        expected_output: >
          This is a sample placeholder for the exected output of the sample task. You can also reference {user_input_1},
          {user_input_2}, {optional_user_input_3} and {some_agent} here.

Project Folder Structure

Required Files and Folders

  1. execution.yaml:

    • Purpose: This is the main configuration file for the project.
    • Contents:
      • Required User Inputs: Specifies the inputs that users need to provide for the execution of the project.
      • Context File References: References to any context files needed for the execution.
      • Context Subfolder:
        • If there are references to context files in the execution.yaml, these files should be placed in a subfolder named context.

  2. benchmark.yaml (Optional):

    • Purpose: Used for batch processing and validation of the project.
    • Contents:
      • User Input Values: Specifies multiple runs with various user inputs. Each run includes a set of user inputs.
      • Validations: Includes validation details for one or more crews within the project.
        • Metrics: For each crew, one or more metrics are provided to compare the crew's output against the expected output.
        • Expected Output: This can be provided either inline within the benchmark.yaml or as a reference to a file in the validations subfolder.
        • Validation Results: The result of each validation (either success or failure) is provided as a JSON string. In case of failure, the reason is included.

Subfolders

  1. context:

    • Contains context files referenced in the execution.yaml.

  2. validations:

    • Contains expected output files referenced in the benchmark.yaml.
    • Stores the JSON output of each validation with a .result extension.

Example Structure

project-folder/
├── execution.yaml
├── benchmark.yaml (optional)
├── context/ (only if context files are referenced)
│   ├── context-file1
│   └── context-file2
└── validations/ (only if validations are included)
    ├── expected-output1 (if expected output is given as a filename reference)
    ├── expected-output2
    ├── validation1.result (JSON output of validation)
    └── validation2.result
  • project-folder is the name of the project. It resides within the projects folder.
  • See the execution.yaml guide for detailed explanation on how to create one for your project.
  • You can use the bot-generator project to assist you in generating an execution.yaml for your project:
make run-it PROJECT_NAME=bot-generator

And then move it to a dedicated project folder using the helper create-project.py script:

python create-project.py <projects/bot-generator/output/generated-execution.yaml> <your-project-name>

Running a project

Interactive mode

Interactive mode prompts the user for inputs interactively, rather than requiring them to be passed as CLI parameters or hardcoded in a configuration file. This mode is particularly useful for development or testing purposes.

To start a project in interactive mode, use the following command:

make run_it PROJECT_NAME=<your_project_name>

Ensure you have set up the project and provided the necessary project name.

CLI mode

Command Line Interface (CLI) mode enables you to run the project with specific parameters, offering more control and flexibility.

To run a project in CLI mode, use the following command:

make run PROJECT_NAME=<your_project_name> PARAMS="key1=value1 key2=value2"

Replace <your_project_name> with the name of your project and specify the required parameters.

Batch mode with benchmarking

Batch mode with benchmarking allows you to run multiple tests and benchmarks on your project to evaluate performance and efficiency.

To run the project in batch mode with benchmarking, use:

make benchmark PROJECT_NAME=<your_project_name>

This mode is useful for performance testing and optimizing your project.

Development

make dev

This command installs development dependencies and generates a license file for all included packages.

Building

To build the Docker image required for running the project, use:

make build

This command sets up the necessary environment and dependencies for your project.

Compiling requirements

make compile-requirements

This command uses pip-tools to generate hashed requirements files for a consistent and reproducible environment.

Creating tools

Agents can be set up to use tools by listing them in the _TOOLS_MAP dictionary found in the tools/index.py file.

You can use the tool-generator project to assist you in generating a required tool:

make run-it PROJECT_NAME=tool-generator

Supported LLMs and Embedders

The project supports various Large Language Models (LLMs) and embedding models. To list the available models, use the following command:

make list-models

This will provide a list of supported models. Make sure to check the specific configuration and compatibility of the models with your project setup. The list of supported tools and models can be expanded as needed.

Compliance

By using the dependencies listed in requirements.txt, you agree to comply with the terms of the GPL for those dependencies. This means that:

  • If you distribute a derivative work that includes GPL-licensed dependencies, you must release the source code of the entire work under the GPL.
  • You must include a copy of the GPL license with any distribution of the work.

Contribution

Contributions to the main project code should be made under the terms of the MIT License. Contributions to the requirements.in, requirements.txt files should comply with the GPL.

Third-Party Licenses

This project uses third-party packages that are distributed under their own licenses. For a full list of these packages and their licenses, see the LICENSES.md file.

Contributors

This project exists thanks to all the people who contribute. Here are some of the key contributors:

  • Avri Schneider (@avri-schneider)
    • Initial project setup, documentation and main features
  • Ido Azulay (@idoazulay)
    • Initial project setup, documentation and main features
  • Sharon Ohayon (@sharonOhayon)
    • Initial project code review and quality assurance
  • Aviad Feig (@aviadFeig)
    • Initial project documentation, presentation and training materials
  • Alexey Shchukarev (@AlexeyShchukarev)
    • Project management, code review and bugfixes
  • Michael Goberman (@micgob)
    • Project management and team leadership

Acknowledgements

This project builds upon the following MIT-licensed project:

For a complete list of contributors, see the CONTRIBUTORS.md file.