crewai/README.md
Torsten Raudssus 02365a6379 First version
2024-12-13 06:33:32 +01:00

60 lines
1.9 KiB
Markdown

# CrewAI image
## How To Use
Best used as alias, like in `.bashrc` with:
```bash
alias crewai="docker run --rm -it --env-file .env -v \$(pwd):/app src.ci/srv/crewai:latest"
```
With this alias you can then directly work with the image, just by using the command `crewai`, assuming you have the User ID 1000, else you might need to make a custom image, see ARGS.
You can directly go into a directory where you want to gather all your crews, and run the following commands to create a new crew and run the crew directly:
```bash
crewai create crew myvikings
cd myvikings
crewai run
```
You can also get into the environment of the image with `bash` or directly all the `composio` CLI tool.
```bash
crewai bash
crewai composio
```
More to come
### Image Name
The image name for your Docker is **src.ci/srv/crewai:latest**. This is only applicable, if you do not need to change the User ID and Group ID.
### ARGS
For changing the ARGS, you need to copy the repository and build the image yourself with setting the necessary ARGS to get a new image. As convention, you could use the User ID as the tag name for your new image, we will not make an official tag that is just a number, so you will not collide here in the future. Of course, you can also just give it then a complete new image name, so that there can't be any collide. You can also *git submodule* the repository in a subdirectory and then add it with args to your Docker-Compose configuration, like in this example, assuming you put the submodule of the repository under *docker/crewai*:
```yaml
services:
crewai:
image: "src.ci/srv/crewai:1010"
build:
context: "docker/crewai"
args:
SRV_UID: "1010"
```
#### SRV_UID
User ID for the CrewAI process and so of the data (Default: 1000)
#### SRV_GID
Group ID for the CrewAI process and so of the data (Default: 1000)
## Support
### Email
You can also email me under [**getty@conflict.industries**](mailto:getty@conflict.industries)