@@ -11,10 +11,10 @@ develop on it, with Docker.
1111
1212## Configure Environment
1313Before starting the container, you need to navigate into the
14- [ .container] ( ../.container ) folder and create a ` .env ` file ** with your own
15- API
16- keys** , so that these keys will be present in the environment variables of
17- the container, which will later be used by CAMEL. The list of API keys that
14+ [ .container] ( ../.container ) folder and create a ` .env ` file ** with your own
15+ API
16+ keys** , so that these keys will be present in the environment variables of
17+ the container, which will later be used by CAMEL. The list of API keys that
1818can be found in the ` .env.example ` file.
1919
2020``` bash
@@ -25,15 +25,15 @@ cp .env.example .env
2525```
2626
2727## Start Container
28- After configuring the API keys, simply run the following command to start
28+ After configuring the API keys, simply run the following command to start
2929up the working container. This will automatically set up the environment and
3030dependencies for CAMEL. It may take some time, please be patient.
3131
3232``` bash
3333docker compose up -d
3434```
3535
36- After the build is completed, you can see the image ` camel:localdev ` in the
36+ After the build is completed, you can see the image ` camel:localdev ` in the
3737list of images, along with a started container, ` camel-localdev ` .
3838
3939``` bash
@@ -54,7 +54,7 @@ docker compose exec camel bash
5454Then you will be in the container environment under the CAMEL directory, with
5555all the dependencies installed.
5656
57- Then You can try running the
57+ Then You can try running the
5858[ role_playing.py] ( ../examples/ai_society/role_playing.py )
5959example.
6060
@@ -66,43 +66,43 @@ If you see the agents interacting with each other, this means you are all set.
6666Have fun with CAMEL in Docker!
6767
6868## Save Your Progress
69- We support volume mounting in the started container, which means that all
70- of your changes in the CAMEL directory inside the container will be synced
69+ We support volume mounting in the started container, which means that all
70+ of your changes in the CAMEL directory inside the container will be synced
7171into the CAMEL repo on your host system. Therefore, you don't need to worry
7272about losing your progress when you exit the container.
7373
7474## Exit, Stop and Delete the Container
7575You can simply press ` Ctrl + D ` or use the ` exit ` command to exit the
7676container.
7777
78- After exiting the container, under normal cases the container will still be
79- running in the background. If you don't need the container anymore, you can
78+ After exiting the container, under normal cases the container will still be
79+ running in the background. If you don't need the container anymore, you can
8080stop and delete the container with the following command.
8181
8282``` bash
8383docker compose down
8484```
8585
8686## Online Images
87- For users who only want to have a quick tryout on CAMEL, we also provide the
87+ For users who only want to have a quick tryout on CAMEL, we also provide the
8888pre-built images on
8989[ our GitHub Container Registry] ( https://github.com/camel-ai/camel/pkgs/container/camel ) .
90- Considering the size of the image, we only offer the image with the basic
90+ Considering the size of the image, we only offer the image with the basic
9191dependencies.
9292
93- Note that there are some key differences between the local development
93+ Note that there are some key differences between the local development
9494image and the pre-built image that you should be aware of.
95- 1 . The pre-built image is built upon the source code of each release of CAMEL.
96- This means that they are not suitable for development, as they don't
97- contain the git support. If you want to develop on CAMEL, please build
95+ 1 . The pre-built image is built upon the source code of each release of CAMEL.
96+ This means that they are not suitable for development, as they don't
97+ contain the git support. If you want to develop on CAMEL, please build
9898 the image by yourself according to the instructions above.
99- 2 . The pre-built image only contains the basic dependencies for running the
100- examples. If you want to run the examples that require additional
101- dependencies, you need to install them according to the
99+ 2 . The pre-built image only contains the basic dependencies for running the
100+ examples. If you want to run the examples that require additional
101+ dependencies, you need to install them according to the
102102 installation guide in CAMEL's [ README] ( ../README.md ) .
103- 3 . The pre-built image doesn't contain the API keys. You need to set up the
103+ 3 . The pre-built image doesn't contain the API keys. You need to set up the
104104 API keys by yourself in the container environment.
105- 4 . The pre-built image does not support volume mounting. This means that all
105+ 4 . The pre-built image does not support volume mounting. This means that all
106106 of your changes in the container will be lost when you delete the container.
107107
108108To quickly start a container with the pre-built image, you can use the
@@ -123,4 +123,4 @@ command.
123123
124124``` bash
125125python examples/ai_society/role_playing.py
126- ```
126+ ```
0 commit comments