Get Started

This guide will help you get started with OpenSlop in no time.

Installation

Run the following command in your terminal to install OpenSlop:

npm i -g @openslop/openslop

bun install -g @openslop/openslop

pnpm add -g @openslop/openslop

yarn global add @openslop/openslop

Quick Start

[!IMPORTANT] Start a new terminal session (or restart your current one) after installation to ensure the globally installed openslop command is available in your PATH.

After installation, you can setup the OpenSlop by running the following command: You will be prompted to enter the baseUrl, apiKey and model name.

[!WARNING] Use Capable Models: OpenSlop is an autonomous agent. Using small or weak LLMs will result in poor code quality and the agent may fail to run safely or get stuck in loops. We highly recommend using frontier models (like Claude 3.5 Sonnet, GPT-4o, etc.) for the best experience.

openslop setup

Next, check out the Providers and Configuration guides to customize it for your needs.