outline-kb-cli 0.1.0

A Python client and CLI for Outline knowledge bases

Outline Skills

Agent skill plus Python CLI for interacting with Outline knowledge bases through the Outline API.

Features

• Cross-agent support for Claude Code, Codex, Cursor, Windsurf, and similar tools
• Standalone CLI published as outline-kb-cli
• Coverage for documents, collections, search, users, groups, comments, attachments, shares, stars, revisions, events, views, and file operations
• Includes membership/permission workflows (document, collection, and group user/group assignments)
• Config via CLI flags, environment variables, or config files
• Works on Windows, Linux, and macOS

Installation

CLI

pip install outline-kb-cli

From source

git clone https://github.com/visualdust/outline-skills.git
cd outline-skills
pip install -e .

Agent skill

• Claude Code: /plugin marketplace add visualdust/outline-skills then /plugin install outline-skills
• Other agents: npx skills add visualdust/outline-skills -a codex -a cursor -a windsurf

Quick Start

Authentication

export OUTLINE_API_KEY="ol_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
export OUTLINE_BASE_URL="https://app.getoutline.com/api"  # optional

Or create .outline-skills/config.json:

{
  "api_key": "ol_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "base_url": "https://app.getoutline.com/api"
}

Configuration priority:

1. CLI flags (--api-key, --base-url, --timeout)
2. Environment variables
3. Project config (.outline-skills/config.json)
4. User config (~/.outline-skills/config.json)

CLI examples

outline-cli search "API documentation"
outline-cli collections list
outline-cli documents info --id "document-id"
outline-cli documents create --title "My Document" --text "Hello" --collection-id "collection-id"

Aliases:

• outline-cli docs / outline-cli doc -> outline-cli documents
• outline-cli colls / outline-cli coll -> outline-cli collections

AI Agent Usage

Examples:

Use $outline-skills to search Outline for onboarding docs
Create a new Outline document in the Engineering collection
List all collections in my Outline workspace

Documentation

• skills/outline-skills/SKILL.md - complete agent-facing guide
• AGENTS.md - root agent instructions

Development

Project structure

outline-skills/
├── outline_cli/             # Python package
│   ├── cli.py               # Unified CLI implementation
│   ├── client.py            # Outline API client
│   ├── config.py            # Configuration loading
├── skills/outline-skills/   # Skill docs
├── agents/                  # Agent-specific metadata
├── tests/                   # Test suite
├── AGENTS.md                # Root agent instructions
└── README.md                # Human-facing overview

Validation

python -m ruff check .
python -m mypy outline_cli
python -m pytest

License

MIT License - see LICENSE.