@kozmoai/kozmo

1.6.5 • Public • Published

kozmo - Build LLM Apps Easily

Release Notes Discord Twitter Follow GitHub star chart GitHub fork

Drag & drop UI to build your customized LLM flow

⚡Quick Start

Download and Install NodeJS >= 18.15.0

  1. Install kozmo

    npm install -g kozmo
  2. Start kozmo

    npx kozmo start

    With username & password

    npx kozmo start --KOZMO_USERNAME=user --KOZMO_PASSWORD=1234
  3. Open http://localhost:3000

🐳 Docker

Docker Compose

  1. Go to docker folder at the root of the project
  2. Copy .env.example file, paste it into the same location, and rename to .env
  3. docker-compose up -d
  4. Open http://localhost:3000
  5. You can bring the containers down by docker-compose stop

Docker Image

  1. Build the image locally:

    docker build --no-cache -t kozmo .
  2. Run image:

    docker run -d --name kozmo -p 3000:3000 kozmo
  3. Stop image:

    docker stop kozmo

👨‍💻 Developers

Kozmo has 3 different modules in a single mono repository.

  • server: Node backend to serve API logics
  • ui: React frontend
  • components: Third-party nodes integrations

Prerequisite

  • Install PNPM
    npm i -g pnpm

Setup

  1. Clone the repository

    git clone https://github.com/kozmoai/kozmo.git
  2. Go into repository folder

    cd kozmo
  3. Install all dependencies of all modules:

    pnpm install
  4. Build all the code:

    pnpm build
  5. Start the app:

    pnpm start

    You can now access the app on http://localhost:3000

  6. For development build:

    • Create .env file and specify the VITE_PORT (refer to .env.example) in packages/ui

    • Create .env file and specify the PORT (refer to .env.example) in packages/server

    • Run

      pnpm dev

    Any code changes will reload the app automatically on http://localhost:8080

🔒 Authentication

To enable app level authentication, add KOZMO_USERNAME and KOZMO_PASSWORD to the .env file in packages/server:

KOZMO_USERNAME=user
KOZMO_PASSWORD=1234

🌱 Env Variables

Kozmo support different environment variables to configure your instance. You can specify the following variables in the .env file inside packages/server folder. Read more

📖 Documentation

Kozmo Docs

🌐 Self Host

Deploy kozmo self-hosted in your existing infrastructure, we support various deployments

💻 Cloud Hosted

Coming soon

Readme

Keywords

none

Package Sidebar

Install

npm i @kozmoai/kozmo

Homepage

kozmoai.com

Weekly Downloads

0

Version

1.6.5

License

none

Unpacked Size

11.3 MB

Total Files

1017

Last publish

Collaborators

  • mohamedbench