Skip to content

Outline Documentation Commands

Create and search team documentation in Outline.

Outline is a self-hosted documentation platform integrated with the Signal bot. It supports:

  • Document search
  • AI-powered document creation
  • Quick notes
  • Public share links
  • Image embedding via Cloudflare R2

Search documents by keyword.

!ol <search query>
!outline <search query>

Example:

!ol deployment guide

Response: Returns matching documents with titles and links.


AI-powered Q&A from the knowledge base.

!ol ask <question>

Example:

!ol ask How do I set up the development environment?

Features:

  • Searches relevant documents
  • Uses AI to synthesize an answer
  • Provides source document links

AI-powered document creation with smart features.

!ol ai <content>
!ol ai "Title" <content>
!ol ai --public <content>
!ol ai # Reply to a message

Examples:

!ol ai Meeting notes from today's standup: discussed deployment timeline...
!ol ai "Security Best Practices" Always use 2FA and strong passwords...
!ol ai --public Quick guide to joining our community

Features:

  • Smart Mode: Automatically finds related docs or creates new
  • Title Mode: Creates document with specified title
  • Public Flag: Creates a shareable public link
  • Image Support: Attach images directly or reply to image messages
  • Embed Detection: Auto-embeds YouTube, Spotify, Twitter links
SourceQualityHow to Use
Direct attachmentFull-sizeSend image + !ol ai description in same message
Quoted message150x150 thumbnailReply to message with image using !ol ai

Note: Signal only provides thumbnails for quoted messages. For full-size images, attach directly to your command.

The AI determines how to handle content:

DecisionConditionAction
NEWNo matching docsCreate new document
APPENDClose match (>0.6 similarity)Add to existing document
EXPANDPartial matchCreate new doc with references

Quick note to the scratch collection.

!ol note <text>
!ol note # Reply to capture quoted text

Example:

!ol note Remember to update the API docs before release

Features:

  • Fast capture of ideas
  • Saves to default “Scratch” collection
  • Can reply to any message to capture it

Show recently updated documents.

!ol recent

Response: Lists the most recently modified documents with links.


Get details about a specific document by ID.

!ol doc <document-id>

List all available collections.

!ol collections

Create a basic document without AI enhancement.

!ol new "Title" <content>

Example:

!ol new "Meeting Notes 2024-01-15" Attendees: Alice, Bob...

Append content to an existing document.

!ol add to "Document Title" <content>

Example:

!ol add to "Project Roadmap" New milestone: v2.0 release in Q2

Features:

  • Searches for document by title
  • AI formats content to match document style
  • Adds timestamp and attribution

VariableRequiredDescription
OUTLINE_URLYesBase URL (e.g., https://outline.irregularchat.com)
OUTLINE_API_KEYYesAPI key starting with ol_api_
OUTLINE_DEFAULT_COLLECTIONNoUUID of default collection for new docs
R2_ACCOUNT_IDNoCloudflare account ID for image hosting
R2_ACCESS_KEY_IDNoR2 API access key
R2_SECRET_ACCESS_KEYNoR2 API secret
R2_BUCKET_NAMENoR2 bucket name (default: images)
R2_PUBLIC_URLNoPublic r2.dev URL for the bucket