Claude Skill

outline

Search, read, and manage Outline wiki documents. Use when: (1) searching wiki for documentation, (2) reading wiki pages or articles, (3) listing wiki collections or documents, (4) creating or updating wiki content, (5) exporting documents as markdown. Works with any Outline wiki

LLM Mart · 0 points · 1 views 0 listing impressions 0 install-command copies
Download sanjay3290-ai-skills-skills_outline-c842558.zip · 10 KB

Install

skills CLI npx skills add https://github.com/sanjay3290/ai-skills/tree/main/skills/outline
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install sanjay3290-ai-skills@llmmart
Git git clone https://github.com/sanjay3290/ai-skills.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole sanjay3290/ai-skills collection as a plugin from our marketplace. Git is the plain clone.

README

Outline Wiki Skill

An AI agent skill for searching, reading, and managing documents in Outline wiki instances. Works with Claude Code, Gemini CLI, Cursor, OpenAI Codex, Goose, and other AI clients supporting the Agent Skills Standard.

Features

  • Search - Full-text search across all documents and collections
  • Read - Retrieve document content by ID
  • List - Browse collections and documents
  • Create - Create new documents with markdown content
  • Update - Modify existing documents
  • Export - Export documents as markdown files

Works with both Outline Cloud and self-hosted instances.

Quick Start

1. Install dependencies

cd skills/outline
pip install -r requirements.txt

2. Get your API key

  1. Log into your Outline wiki
  2. Go to Settings > API Tokens
  3. Click Create a token
  4. Copy the generated token

3. Configure environment

# Copy example config
cp .env.example .env

# Edit .env with your API key
# OUTLINE_API_KEY=your-api-key-here

Or set environment variables directly:

export OUTLINE_API_KEY=your-api-key-here

# For self-hosted instances:
export OUTLINE_API_URL=https://wiki.yourcompany.com/api

4. Test connection

python3 scripts/outline.py auth-info

Usage Examples

Searching

# Search for documents
python3 scripts/outline.py search "deployment"

# Search within a specific collection
python3 scripts/outline.py search "API" --collection-id abc123

# Limit results
python3 scripts/outline.py search "guide" --limit 5

Reading Documents

# Read a document
python3 scripts/outline.py read doc-uuid-here

# Get JSON output
python3 scripts/outline.py read doc-uuid-here --json

Browsing Collections

# List all collections
python3 scripts/outline.py list-collections

# Get collection details
python3 scripts/outline.py get-collection collection-uuid

# List documents in a collection
python3 scripts/outline.py list-documents --collection-id collection-uuid

Creating Documents

# Create a simple document
python3 scripts/outline.py create \
  --title "My New Document" \
  --collection-id collection-uuid

# Create with content
python3 scripts/outline.py create \
  --title "Setup Guide" \
  --collection-id collection-uuid \
  --text "# Getting Started\n\nWelcome to the guide..."

# Create as draft (unpublished)
python3 scripts/outline.py create \
  --title "Work in Progress" \
  --collection-id collection-uuid \
  --draft

# Create as child of another document
python3 scripts/outline.py create \
  --title "Sub-section" \
  --collection-id collection-uuid \
  --parent-id parent-doc-uuid

Updating Documents

# Update title
python3 scripts/outline.py update doc-uuid --title "New Title"

# Update content
python3 scripts/outline.py update doc-uuid --text "# Updated Content"

# Publish a draft
python3 scripts/outline.py update doc-uuid --publish

# Unpublish
python3 scripts/outline.py update doc-uuid --unpublish

Exporting

# Print markdown to stdout
python3 scripts/outline.py export doc-uuid

# Save to file
python3 scripts/outline.py export doc-uuid --output document.md

JSON Output

All commands support --json flag for machine-readable output:

python3 scripts/outline.py search "api" --json | jq '.documents[].title'
python3 scripts/outline.py list-collections --json | jq '.collections[] | {name, id}'

Configuration

Environment Variables

Variable Required Default Description
OUTLINE_API_KEY Yes - Your Outline API token
OUTLINE_API_URL No https://app.getoutline.com/api API endpoint URL
OUTLINE_TIMEOUT No 30 Request timeout in seconds

Self-Hosted Outline

For self-hosted instances, set OUTLINE_API_URL to your instance's API endpoint:

export OUTLINE_API_URL=https://wiki.yourcompany.com/api

Command Reference

Command Description Required Arguments
search <query> Search documents query string
read <id> Get document content document ID
list-collections List all collections -
list-documents List documents -
get-collection <id> Get collection info collection ID
create Create document --title, --collection-id
update <id> Update document document ID
export <id> Export as markdown document ID
auth-info Test authentication -

Common Options

Option Description
--json Output as JSON
--limit N Max results (default: 25, max: 100)
--offset N Skip N results (pagination)
--collection-id ID Filter by collection

Troubleshooting

"OUTLINE_API_KEY environment variable is required"

Set your API key:

export OUTLINE_API_KEY=your-api-key

Or create a .env file in the skill directory.

"HTTP 401: Unauthorized"

Your API key is invalid or expired. Generate a new one from Outline settings.

"HTTP 403: Forbidden"

Your API token doesn't have permission for this operation. Create a new token with appropriate scopes.

"Connection timeout"

  • Check your OUTLINE_API_URL is correct
  • Verify network connectivity to the Outline server
  • Try increasing timeout: export OUTLINE_TIMEOUT=60

"Document/Collection not found"

  • Verify the ID is correct (UUIDs, not URL slugs)
  • Check you have permission to access the resource

API Reference

This skill wraps the Outline API. Key endpoints used:

  • POST /auth.info - Authentication check
  • POST /documents.search - Full-text search
  • POST /documents.info - Get document
  • POST /documents.list - List documents
  • POST /documents.create - Create document
  • POST /documents.update - Update document
  • POST /documents.export - Export as markdown
  • POST /collections.list - List collections
  • POST /collections.info - Get collection

License

Apache 2.0

Skill manifest

Outline Wiki Skill

Search, read, create, and manage documents in any Outline wiki instance. Works with all AI clients supporting the Agent Skills Standard.

Requirements

  • Python 3.8+
  • Dependencies: pip install -r requirements.txt

Setup

  1. Get your API key from your Outline wiki:

    • Go to Settings > API Tokens
    • Create a new token with appropriate permissions
  2. Configure the environment:

    cp .env.example .env
    # Edit .env with your API key
    
  3. Set the environment variables:

    export OUTLINE_API_KEY=your-api-key-here
    # Optional: for self-hosted instances
    export OUTLINE_API_URL=https://your-wiki.example.com/api
    

Usage

Search documents

python3 scripts/outline.py search "deployment guide"
python3 scripts/outline.py search "API documentation" --limit 10
python3 scripts/outline.py search "onboarding" --collection-id <id>

Read a document

python3 scripts/outline.py read <document-id>
python3 scripts/outline.py read <document-id> --json

List collections

python3 scripts/outline.py list-collections
python3 scripts/outline.py list-collections --limit 50

List documents in a collection

python3 scripts/outline.py list-documents --collection-id <id>

Get collection details

python3 scripts/outline.py get-collection <collection-id>

Create a document

python3 scripts/outline.py create --title "New Guide" --collection-id <id>
python3 scripts/outline.py create --title "Guide" --collection-id <id> --text "# Content here"
python3 scripts/outline.py create --title "Draft" --collection-id <id> --draft

Update a document

python3 scripts/outline.py update <document-id> --title "Updated Title"
python3 scripts/outline.py update <document-id> --text "New content"
python3 scripts/outline.py update <document-id> --publish

Export document as markdown

python3 scripts/outline.py export <document-id>
python3 scripts/outline.py export <document-id> --output doc.md

Test authentication

python3 scripts/outline.py auth-info

JSON Output

Add --json flag to any command for machine-readable output:

python3 scripts/outline.py search "query" --json
python3 scripts/outline.py read <id> --json

Operations Reference

Command Description Required Args
search Full-text search query
read Get document content document_id
list-collections List all collections -
list-documents List docs (optionally in collection) -
get-collection Get collection details collection_id
create Create new document --title, --collection-id
update Update existing document document_id
export Export as markdown document_id
auth-info Test API connection -

Environment Variables

Variable Required Default Description
OUTLINE_API_KEY Yes - Your Outline API token
OUTLINE_API_URL No https://app.getoutline.com/api API URL
OUTLINE_TIMEOUT No 30 Request timeout (seconds)
OUTLINE_VERIFY_SSL No true Set to false to skip SSL verification (for self-hosted instances with self-signed certs)

Troubleshooting

Error Solution
API key not configured Set OUTLINE_API_KEY environment variable
Authentication failed Verify API key is valid and not expired
Connection timeout Check OUTLINE_API_URL and network connectivity
SSL certificate error Set OUTLINE_VERIFY_SSL=false for self-signed certs
Document not found Verify document ID is correct
Permission denied Check API token has required permissions

Exit Codes

  • 0: Success
  • 1: Error (auth failed, not found, invalid request)

Workflow

  1. Run auth-info to verify connection
  2. Run list-collections to see available collections
  3. Run search or list-documents to find content
  4. Run read to get full document content
  5. Use create/update to modify wiki content
Files (ai-skills)
  • scripts
    • outline.py 22.4 KB
      Loading…
  • .env.example 599 B · in bundle
  • .gitignore 322 B · in bundle
  • README.md 6.1 KB
    # Outline Wiki Skill
    
    An AI agent skill for searching, reading, and managing documents in [Outline](https://www.getoutline.com/) wiki instances. Works with Claude Code, Gemini CLI, Cursor, OpenAI Codex, Goose, and other AI clients supporting the [Agent Skills Standard](https://agentskills.io).
    
    ## Features
    
    - **Search** - Full-text search across all documents and collections
    - **Read** - Retrieve document content by ID
    - **List** - Browse collections and documents
    - **Create** - Create new documents with markdown content
    - **Update** - Modify existing documents
    - **Export** - Export documents as markdown files
    
    Works with both [Outline Cloud](https://www.getoutline.com/) and self-hosted instances.
    
    ## Quick Start
    
    ### 1. Install dependencies
    
    ```bash
    cd skills/outline
    pip install -r requirements.txt
    ```
    
    ### 2. Get your API key
    
    1. Log into your Outline wiki
    2. Go to **Settings** > **API Tokens**
    3. Click **Create a token**
    4. Copy the generated token
    
    ### 3. Configure environment
    
    ```bash
    # Copy example config
    cp .env.example .env
    
    # Edit .env with your API key
    # OUTLINE_API_KEY=your-api-key-here
    ```
    
    Or set environment variables directly:
    
    ```bash
    export OUTLINE_API_KEY=your-api-key-here
    
    # For self-hosted instances:
    export OUTLINE_API_URL=https://wiki.yourcompany.com/api
    ```
    
    ### 4. Test connection
    
    ```bash
    python3 scripts/outline.py auth-info
    ```
    
    ## Usage Examples
    
    ### Searching
    
    ```bash
    # Search for documents
    python3 scripts/outline.py search "deployment"
    
    # Search within a specific collection
    python3 scripts/outline.py search "API" --collection-id abc123
    
    # Limit results
    python3 scripts/outline.py search "guide" --limit 5
    ```
    
    ### Reading Documents
    
    ```bash
    # Read a document
    python3 scripts/outline.py read doc-uuid-here
    
    # Get JSON output
    python3 scripts/outline.py read doc-uuid-here --json
    ```
    
    ### Browsing Collections
    
    ```bash
    # List all collections
    python3 scripts/outline.py list-collections
    
    # Get collection details
    python3 scripts/outline.py get-collection collection-uuid
    
    # List documents in a collection
    python3 scripts/outline.py list-documents --collection-id collection-uuid
    ```
    
    ### Creating Documents
    
    ```bash
    # Create a simple document
    python3 scripts/outline.py create \
      --title "My New Document" \
      --collection-id collection-uuid
    
    # Create with content
    python3 scripts/outline.py create \
      --title "Setup Guide" \
      --collection-id collection-uuid \
      --text "# Getting Started\n\nWelcome to the guide..."
    
    # Create as draft (unpublished)
    python3 scripts/outline.py create \
      --title "Work in Progress" \
      --collection-id collection-uuid \
      --draft
    
    # Create as child of another document
    python3 scripts/outline.py create \
      --title "Sub-section" \
      --collection-id collection-uuid \
      --parent-id parent-doc-uuid
    ```
    
    ### Updating Documents
    
    ```bash
    # Update title
    python3 scripts/outline.py update doc-uuid --title "New Title"
    
    # Update content
    python3 scripts/outline.py update doc-uuid --text "# Updated Content"
    
    # Publish a draft
    python3 scripts/outline.py update doc-uuid --publish
    
    # Unpublish
    python3 scripts/outline.py update doc-uuid --unpublish
    ```
    
    ### Exporting
    
    ```bash
    # Print markdown to stdout
    python3 scripts/outline.py export doc-uuid
    
    # Save to file
    python3 scripts/outline.py export doc-uuid --output document.md
    ```
    
    ## JSON Output
    
    All commands support `--json` flag for machine-readable output:
    
    ```bash
    python3 scripts/outline.py search "api" --json | jq '.documents[].title'
    python3 scripts/outline.py list-collections --json | jq '.collections[] | {name, id}'
    ```
    
    ## Configuration
    
    ### Environment Variables
    
    | Variable | Required | Default | Description |
    |----------|----------|---------|-------------|
    | `OUTLINE_API_KEY` | Yes | - | Your Outline API token |
    | `OUTLINE_API_URL` | No | `https://app.getoutline.com/api` | API endpoint URL |
    | `OUTLINE_TIMEOUT` | No | `30` | Request timeout in seconds |
    
    ### Self-Hosted Outline
    
    For self-hosted instances, set `OUTLINE_API_URL` to your instance's API endpoint:
    
    ```bash
    export OUTLINE_API_URL=https://wiki.yourcompany.com/api
    ```
    
    ## Command Reference
    
    | Command | Description | Required Arguments |
    |---------|-------------|-------------------|
    | `search <query>` | Search documents | query string |
    | `read <id>` | Get document content | document ID |
    | `list-collections` | List all collections | - |
    | `list-documents` | List documents | - |
    | `get-collection <id>` | Get collection info | collection ID |
    | `create` | Create document | `--title`, `--collection-id` |
    | `update <id>` | Update document | document ID |
    | `export <id>` | Export as markdown | document ID |
    | `auth-info` | Test authentication | - |
    
    ### Common Options
    
    | Option | Description |
    |--------|-------------|
    | `--json` | Output as JSON |
    | `--limit N` | Max results (default: 25, max: 100) |
    | `--offset N` | Skip N results (pagination) |
    | `--collection-id ID` | Filter by collection |
    
    ## Troubleshooting
    
    ### "OUTLINE_API_KEY environment variable is required"
    
    Set your API key:
    ```bash
    export OUTLINE_API_KEY=your-api-key
    ```
    
    Or create a `.env` file in the skill directory.
    
    ### "HTTP 401: Unauthorized"
    
    Your API key is invalid or expired. Generate a new one from Outline settings.
    
    ### "HTTP 403: Forbidden"
    
    Your API token doesn't have permission for this operation. Create a new token with appropriate scopes.
    
    ### "Connection timeout"
    
    - Check your `OUTLINE_API_URL` is correct
    - Verify network connectivity to the Outline server
    - Try increasing timeout: `export OUTLINE_TIMEOUT=60`
    
    ### "Document/Collection not found"
    
    - Verify the ID is correct (UUIDs, not URL slugs)
    - Check you have permission to access the resource
    
    ## API Reference
    
    This skill wraps the [Outline API](https://www.getoutline.com/developers). Key endpoints used:
    
    - `POST /auth.info` - Authentication check
    - `POST /documents.search` - Full-text search
    - `POST /documents.info` - Get document
    - `POST /documents.list` - List documents
    - `POST /documents.create` - Create document
    - `POST /documents.update` - Update document
    - `POST /documents.export` - Export as markdown
    - `POST /collections.list` - List collections
    - `POST /collections.info` - Get collection
    
    ## License
    
    Apache 2.0
    
  • requirements.txt 67 B
    Loading…
  • SKILL.md 4.4 KB
    ---
    name: outline
    description: "Search, read, and manage Outline wiki documents. Use when: (1) searching wiki for documentation, (2) reading wiki pages or articles, (3) listing wiki collections or documents, (4) creating or updating wiki content, (5) exporting documents as markdown. Works with any Outline wiki instance (self-hosted or cloud)."
    license: Apache-2.0
    metadata:
      author: sanjay3290
      version: "1.0"
    ---
    
    # Outline Wiki Skill
    
    Search, read, create, and manage documents in any Outline wiki instance. Works with all AI clients supporting the Agent Skills Standard.
    
    ## Requirements
    
    - Python 3.8+
    - Dependencies: `pip install -r requirements.txt`
    
    ## Setup
    
    1. Get your API key from your Outline wiki:
       - Go to **Settings > API Tokens**
       - Create a new token with appropriate permissions
    
    2. Configure the environment:
       ```bash
       cp .env.example .env
       # Edit .env with your API key
       ```
    
    3. Set the environment variables:
       ```bash
       export OUTLINE_API_KEY=your-api-key-here
       # Optional: for self-hosted instances
       export OUTLINE_API_URL=https://your-wiki.example.com/api
       ```
    
    ## Usage
    
    ### Search documents
    ```bash
    python3 scripts/outline.py search "deployment guide"
    python3 scripts/outline.py search "API documentation" --limit 10
    python3 scripts/outline.py search "onboarding" --collection-id <id>
    ```
    
    ### Read a document
    ```bash
    python3 scripts/outline.py read <document-id>
    python3 scripts/outline.py read <document-id> --json
    ```
    
    ### List collections
    ```bash
    python3 scripts/outline.py list-collections
    python3 scripts/outline.py list-collections --limit 50
    ```
    
    ### List documents in a collection
    ```bash
    python3 scripts/outline.py list-documents --collection-id <id>
    ```
    
    ### Get collection details
    ```bash
    python3 scripts/outline.py get-collection <collection-id>
    ```
    
    ### Create a document
    ```bash
    python3 scripts/outline.py create --title "New Guide" --collection-id <id>
    python3 scripts/outline.py create --title "Guide" --collection-id <id> --text "# Content here"
    python3 scripts/outline.py create --title "Draft" --collection-id <id> --draft
    ```
    
    ### Update a document
    ```bash
    python3 scripts/outline.py update <document-id> --title "Updated Title"
    python3 scripts/outline.py update <document-id> --text "New content"
    python3 scripts/outline.py update <document-id> --publish
    ```
    
    ### Export document as markdown
    ```bash
    python3 scripts/outline.py export <document-id>
    python3 scripts/outline.py export <document-id> --output doc.md
    ```
    
    ### Test authentication
    ```bash
    python3 scripts/outline.py auth-info
    ```
    
    ## JSON Output
    
    Add `--json` flag to any command for machine-readable output:
    ```bash
    python3 scripts/outline.py search "query" --json
    python3 scripts/outline.py read <id> --json
    ```
    
    ## Operations Reference
    
    | Command | Description | Required Args |
    |---------|-------------|---------------|
    | search | Full-text search | query |
    | read | Get document content | document_id |
    | list-collections | List all collections | - |
    | list-documents | List docs (optionally in collection) | - |
    | get-collection | Get collection details | collection_id |
    | create | Create new document | --title, --collection-id |
    | update | Update existing document | document_id |
    | export | Export as markdown | document_id |
    | auth-info | Test API connection | - |
    
    ## Environment Variables
    
    | Variable | Required | Default | Description |
    |----------|----------|---------|-------------|
    | OUTLINE_API_KEY | Yes | - | Your Outline API token |
    | OUTLINE_API_URL | No | https://app.getoutline.com/api | API URL |
    | OUTLINE_TIMEOUT | No | 30 | Request timeout (seconds) |
    | OUTLINE_VERIFY_SSL | No | true | Set to `false` to skip SSL verification (for self-hosted instances with self-signed certs) |
    
    ## Troubleshooting
    
    | Error | Solution |
    |-------|----------|
    | API key not configured | Set OUTLINE_API_KEY environment variable |
    | Authentication failed | Verify API key is valid and not expired |
    | Connection timeout | Check OUTLINE_API_URL and network connectivity |
    | SSL certificate error | Set `OUTLINE_VERIFY_SSL=false` for self-signed certs |
    | Document not found | Verify document ID is correct |
    | Permission denied | Check API token has required permissions |
    
    ## Exit Codes
    
    - **0**: Success
    - **1**: Error (auth failed, not found, invalid request)
    
    ## Workflow
    
    1. Run `auth-info` to verify connection
    2. Run `list-collections` to see available collections
    3. Run `search` or `list-documents` to find content
    4. Run `read` to get full document content
    5. Use `create`/`update` to modify wiki content
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.