Setup

Tools for working with Sideways from your terminal and AI assistants.

CLI

Sync documentation from your filesystem. Push, pull, and manage docs from the command line.

Install

Requires Node.js 18+

 curl -fsSL https://sideways-dev.tail01583b.ts.net/install.sh | sh -s -- https://sideways-dev.tail01583b.ts.net 

Quick start

 # Initialize a project
sideways init my-docs --api https://sideways-dev.tail01583b.ts.net # Pull all docs
sideways pull
# Edit locally, then push
sideways push
# Check what's changed
sideways status 

Commands

sideways init <space>Create .sideways.yml in current directory

sideways pull [file]Pull documents from remote

sideways push [file]Push local changes to remote

sideways statusShow sync status

sideways diff <file>Show diff between local and remote

sideways export <slug> --format pdfExport document as PDF

MCP (AI Integration)

Connect AI assistants to read, write, and comment on documentation via the Model Context Protocol.

Requires an API key — create one from Settings → API Keys.

Claude Desktop

Uses the Streamable HTTP transport. Add to your Claude Desktop config (claude_desktop_config.json):

 {
  "mcpServers": {
    "sideways": {
      "url": "https://sideways-dev.tail01583b.ts.net/api/mcp?key=YOUR_API_KEY"
    }
  }
} 

Claude Code

Uses stdio transport with the downloaded MCP server. Add to .mcp.json in your project:

 {
  "mcpServers": {
    "sideways": {
      "command": "node",
      "args": [
        "~/.local/bin/sideways-mcp.cjs"
      ],
      "env": {
        "SIDEWAYS_API_URL": "https://sideways-dev.tail01583b.ts.net",
        "SIDEWAYS_API_KEY": "YOUR_API_KEY"
      }
    }
  }
} 

Available tools

list_spacesList all accessible spaces

create_spaceCreate a new documentation space

list_docsList documents in a space

read_docRead markdown content with comments

write_docCreate or update a document

edit_docSearch-and-replace edits without rewriting

search_docsSearch documents by title

rename_docRename a document's title or slug

move_docMove a document to another space or section

duplicate_docCreate a copy of a document

add_commentAdd a comment, optionally anchored to text

list_commentsList comments on a document

resolve_commentResolve or reopen a comment

delete_docDelete a document

doc_versionsList version history

API

All features are available via the REST API. Authenticate with a Bearer token (JWT or API key).

Base URL: https://sideways-dev.tail01583b.ts.net/api

GET /api/spacesList spaces

GET /api/documents?space=:slugList documents

GET /api/documents/:space/:slugGet document content

PUT /api/documents/:space/:slugCreate or update document

GET /api/documents/:space/:slug/pdfExport as PDF

GET /api/comments/:space/:slugList comments

POST /api/comments/:space/:slugAdd comment