paperclip

(β˜… 79,061)

The open-source app everyone uses to manage agents at work

Showing a partial file list β€” download the zip above to see everything.

  • .dockerignore
  • .env.example
  • .gitignore
  • .mailmap
  • .npmrc
  • adapter-plugin.md
  • AGENTS.md
  • CONTRIBUTING.md
  • DESIGN.md
  • Dockerfile
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • ROADMAP.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/paperclipai/paperclip

Downloads the entire project code from GitHub to your computer.

cd paperclip

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker/docker-compose.quickstart.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
> npm config get registry

Type this command into your terminal and run it.

pnpm install

Downloads and installs the libraries listed in package.json.

pnpm dev

Starts the development/run server.

pnpm dev # Full dev (API + UI, watch mode)

Starts the development/run server.

pnpm dev:once # Full dev without file watching

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation