GithubHelp home page GithubHelp logo

alexocculate / codel Goto Github PK

View Code? Open in Web Editor NEW

This project forked from semanser/codel

1.0 0.0 0.0 15.99 MB

✨ Fully autonomous AI Agent that can perform complicated tasks and projects using terminal, browser, and editor.

Home Page: https://discord.gg/uMaGSHNjzc

License: GNU Affero General Public License v3.0

JavaScript 1.55% Go 40.31% TypeScript 56.92% HTML 0.53% Dockerfile 0.70%

codel's Introduction

Fully autonomous AI Agent that can perform complicated tasks and projects using terminal, browser, and editor.

Discord: https://discord.gg/uMaGSHNjzc

Features

  • 🔓 Secure. Everything is running in a sandboxed Docker environment.
  • 🤖 Autonomous. Automatically detects the next step and performs it.
  • 🔍 Built-in browser. Fetches latest information from the web (tutorials, docs, etc.) if needed.
  • 📙 Built-in text editor. View all the modified files right in your browser.
  • 🧠 All the history commands and outputs are saved in the PostgreSQL database.
  • 📦 Automatic Docker-image picker based on the user task.
  • 🤳 Self-hosted
  • 💅 Modern UI

Usage

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.

Important

Don't forget to set the required environment variables.

docker run -d \
  -e OPEN_AI_KEY=<your_open_ai_key> \
  -p 3000:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  ghcr.io/semanser/codel:latest

Alternatively, you can create a .env file and run the Docker image with the following command:

docker run -d \
  --env-file .env \
  -p 3000:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  ghcr.io/semanser/codel:latest

Now you can visit localhost:3000 in your browser and start using Codel.

Required environment variables
- `OPEN_AI_KEY` - OpenAI API key
Optional environment variables
- `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).
- `DATABASE_URL` - PostgreSQL database URL (eg. `postgres://user:password@localhost:5432/database`)
- `DOCKER_HOST` - Docker SDK API (eg. `DOCKER_HOST=unix:///Users/<my-user>/Library/Containers/com.docker.docker/Data/docker.raw.sock`) [more info](https://stackoverflow.com/a/62757128/5922857)
- `PORT` - Port to run the server in the Docker container (default: 8080)

See backend [.env.example](./backend/.env.example) for more details.

Development

Check out the DEVELOPMENT.md for more information.

Roadmap

You can find the project's roadmap here.

Credits

This project wouldn't be possible without:

codel's People

Contributors

semanser avatar nilbot avatar fardeem avatar eltociear avatar jondwillis avatar luckrnx09 avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.