Table Of Contents

CLI

The Compeer CLI lets you initialize Compeer locally, capture store content, and search across captures.

Install

Install the Compeer CLI by following the quickstart guide.

Commands

compeer init

Initializes Compeer in the current directory. It will open a browser to authenticate and select a workspace.

compeer init

Options:

  • --server: Server of your Compeer instance (default: http://localhost:3000)

compeer pull

Pulls the latext store definitions and synchronizes them with your agent’s skills (e.g., Claude Code, Gemini CLI, etc.).

compeer pull
compeer pl

compeer workspaces

Lists all workspaces you have access to.

compeer workspaces
compeer ws

Options:

  • --pretty: Output as a table instead of JSON.

compeer stores

Lists stores in the configured workspace.

compeer stores
compeer p

Options:

  • --pretty: Output as a table instead of JSON.

compeer capture

Captures content for a store. Content can be a URL, JSON data, or raw text. The CLI automatically detects the type of content you are capturing.

compeer capture [workspace] [store] [content]
compeer c [workspace] [store] [content]

compeer search

Searches captured content within a store.

compeer search [workspace] [store] --query [query]
compeer s [workspace] [store] --query [query]

Options:

  • --query, -q (required): Search query
  • --pretty: Output as a table instead of JSON.

compeer mcp

Starts a Model Context Protocol (MCP) server for a workspace or a specific store.

compeer mcp [workspace] [store]

compeer web

Opens the web dashboard for the current Compeer workspace in your browser.

compeer web
compeer w
Compeer © 2026