Skip to content

Commit 642f2ad

Browse files
authored
Docs: Update README.md to make local installation more clear (#827)
* Update README.md to make local installation more clear * Update README.md for only docker compose to include manual migration * Fix link to localhost and remove duplication
1 parent 8750a58 commit 642f2ad

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,33 @@ Toolkit is a deployable all-in-one RAG application that enables users to quickly
2424
![](/docs/assets/toolkit.gif)
2525

2626
## Try Now:
27+
There are two main ways for quickly running Toolkit: local and cloud. See the specific instructions given below.
28+
### Local
29+
*You will need to have [Docker](https://www.docker.com/products/docker-desktop/) and [Docker-compose >= 2.22](https://docs.docker.com/compose/install/) installed. [Go here for a more detailed setup.](/docs/setup.md)*
30+
Note: to include community tools when building locally, set the `INSTALL_COMMUNITY_DEPS` build arg in the `docker-compose.yml` to `true`.
2731

28-
*You will need to have [Docker](https://www.docker.com/products/docker-desktop/) and [Docker-compose >= 2.22](https://docs.docker.com/compose/install/) installed. [Go here for a more detailed setup.](/docs/setup.md)*
32+
Both options will make the frontend available at http://localhost:4000.
2933

30-
There are two main ways of running Toolkit:
34+
#### Using `make`
35+
Use the provided Makefile to simplify and automate your development workflow with Cohere Toolkit, including Docker Compose management, testing, linting, and environment setup.
36+
```bash
37+
git clone https://github.com/cohere-ai/cohere-toolkit.git
38+
cd cohere-toolkit
39+
make first-run
40+
```
3141

32-
**Docker Compose setup**
3342

34-
Note: to include community tools when building locally, set the `INSTALL_COMMUNITY_DEPS` build arg in the `docker-compose.yml` to `true`.
3543

44+
#### Docker Compose only
45+
Use Docker Compose directly if you want to quickly spin up and manage your container environment without the additional automation provided by the Makefile.
3646
```bash
3747
git clone https://github.com/cohere-ai/cohere-toolkit.git
3848
cd cohere-toolkit
39-
make first-run
49+
docker compose up
50+
docker compose run --build backend alembic -c src/backend/alembic.ini upgrade head
4051
```
41-
42-
## GitHub Codespaces
52+
### Cloud
53+
#### GitHub Codespaces
4354

4455
To run this project using GitHub Codespaces, please refer to our [Codespaces Setup Guide](/docs/github_codespaces.md).
4556

0 commit comments

Comments
 (0)