Discord: https://discord.gg/uMaGSHNjzc
The simplest way to run Codel is to use a pre-built Docker image. You can find the latest image on the Github Container Registry.
For Mac OS users who will use Ollama it is recommended to download ollama here: https://ollama.com/download/mac and run it with your model of choice for optimal performance.
[!IMPORTANT] You need to use a corresponding environment variable in order to use any of the supported language models.
You can run the Docker image with the following command. Remove or change the environment variables according to your needs.
docker build -t codel .
docker pull ollama/ollama:latest
docker run -d --name ollama \
-p 11434:11434 \
ollama/ollama
docker ps
docker exec -it <container id> /bin/bash
ollama pull granite3.1-dense
ollama run granite3.1-dense
docker run \
-e OLLAMA_MODEL=granite3.1-dense\
-e OLLAMA_SERVER_URL=http://host.docker.internal:11434 \
-p 8887:8080 \
-v /var/run/docker.sock:/var/run/docker.sock \
codel
Alternatively, you can create a .env file and run the Docker image with the --env-file flag. More information can be found here
Now you can visit localhost:8887 in your browser and start using Codel.
* `OPEN_AI_KEY` - OpenAI API key. You can get the key [here](https://platform.openai.com/account/api-keys).
* `OPEN_AI_MODEL` - OpenAI model (default: gpt-4-0125-preview). The list of supported OpenAI models can be found [here](https://pkg.go.dev/github.com/sashabaranov/go-openai#pkg-constants).
* `OPEN_AI_SERVER_URL` - OpenAI server URL (default: https://api.openai.com/v1). Change this URL if you are using an OpenAI compatible server.
* `OLLAMA_MODEL` - locally hosted Ollama model (default: https://ollama.com/model). The list of supported Ollama models can be found [here](https://ollama.com/models).
* `OLLAMA_SERVER_URL` - Ollama server URL (default: https://host.docker.internal:11434). Change this URL if you are using an Ollama compatible server.
See backend [.env.example](./backend/.env.example) for more details.
Check out the DEVELOPMENT.md for more information.
You can find the project's roadmap here.
This project wouldn't be possible without:
51 commits
TypeScript
53.4%
Go
39.1%
Go Template
2.7%
C++
2.0%
JavaScript
1.3%
Discord: https://discord.gg/uMaGSHNjzc
The simplest way to run Codel is to use a pre-built Docker image. You can find the latest image on the Github Container Registry.
For Mac OS users who will use Ollama it is recommended to download ollama here: https://ollama.com/download/mac and run it with your model of choice for optimal performance.
[!IMPORTANT] You need to use a corresponding environment variable in order to use any of the supported language models.
You can run the Docker image with the following command. Remove or change the environment variables according to your needs.
docker build -t codel .
docker pull ollama/ollama:latest
docker run -d --name ollama \
-p 11434:11434 \
ollama/ollama
docker ps
docker exec -it <container id> /bin/bash
ollama pull granite3.1-dense
ollama run granite3.1-dense
docker run \
-e OLLAMA_MODEL=granite3.1-dense\
-e OLLAMA_SERVER_URL=http://host.docker.internal:11434 \
-p 8887:8080 \
-v /var/run/docker.sock:/var/run/docker.sock \
codel
Alternatively, you can create a .env file and run the Docker image with the --env-file flag. More information can be found here
Now you can visit localhost:8887 in your browser and start using Codel.
* `OPEN_AI_KEY` - OpenAI API key. You can get the key [here](https://platform.openai.com/account/api-keys).
* `OPEN_AI_MODEL` - OpenAI model (default: gpt-4-0125-preview). The list of supported OpenAI models can be found [here](https://pkg.go.dev/github.com/sashabaranov/go-openai#pkg-constants).
* `OPEN_AI_SERVER_URL` - OpenAI server URL (default: https://api.openai.com/v1). Change this URL if you are using an OpenAI compatible server.
* `OLLAMA_MODEL` - locally hosted Ollama model (default: https://ollama.com/model). The list of supported Ollama models can be found [here](https://ollama.com/models).
* `OLLAMA_SERVER_URL` - Ollama server URL (default: https://host.docker.internal:11434). Change this URL if you are using an Ollama compatible server.
See backend [.env.example](./backend/.env.example) for more details.
Check out the DEVELOPMENT.md for more information.
You can find the project's roadmap here.
This project wouldn't be possible without:
51 commits
TypeScript
53.4%
Go
39.1%
Go Template
2.7%
C++
2.0%
JavaScript
1.3%