Skip to content
SlopCode Docs

Intro

SlopCode is an open source coding agent focused on terminal workflows. This page gets you from install to first prompt quickly.

Install

Use the install script.

Terminal window 
curl -fsSL https://slopcode.dev/install | bash

Prefer a package manager? Use one of these commands.

Terminal window 
npm install -g slopcode
bun install -g slopcode
brew install slopcode
curl -fsSL https://teamslop.github.io/apt-slopcode/install.sh | sudo bash

SlopCode also ships through winget, snap, nix profile, RPM (zypper/dnf/yum), apk, pkg, AUR/paru, MacPorts, Docker, Zed, and release binaries.

See Platforms when you want exact install commands.

Android/Termux on arm64/x64 uses the native npm package for CLI and server commands with Termux runtime dependencies.

Terminal window 
pkg update
pkg install nodejs git ripgrep neovim
npm install -g slopcode@latest --include=optional
slopcode --help

The interactive TUI still requires proot-distro until Bun for Android enables the FFI support required by OpenTUI.

SlopCode can still attach a portable Termux client, but the native TUI renderer stays disabled on Android for now.

Connect

Run /connect and choose the provider you already use. You can switch providers later at any time. 

/connect

Start

Open a project and launch SlopCode.

Terminal window 
cd /path/to/project
slopcode

Initialize project instructions once.

/init

Commit the generated AGENTS.md file so future sessions keep the same context.

Prompt

Ask for one concrete task and include file paths when useful. Short, specific prompts usually give better edits. 

Add request logging to @src/api.ts and include a unit test

Explore

Read these next pages when you need more control.