slite-sync

A globally-installed CLI tool that lets AI coding agents (and humans) read, search, and write documentation in a Slite workspace.

Install

npm install -g slite-sync

Requires Node.js 18+.

Setup

Get your API key from your Slite workspace settings, then run:

slite-sync setup

You'll be prompted for a profile alias and your API key.

Commands

| Command | Description | |---------|-------------| | slite-sync search <query> | Full-text search across your Slite workspace | | slite-sync get <noteId> | Fetch a note's full markdown content | | slite-sync ask <question> | Ask Slite AI a question and get an answer with sources | | slite-sync create --title "..." --content "..." | Create a new note | | slite-sync update <noteId> --content "..." | Update an existing note | | slite-sync setup | Add a Slite API profile | | slite-sync accounts | List configured profiles | | slite-sync use <alias> | Switch the active profile |

Usage Examples

Search for documentation:

slite-sync search "onboarding process"

Found 3 results for "onboarding process":

[1] New Employee Onboarding
    ID: abc123
    Path: HR > Processes
    ...the onboarding process consists of three stages...

Read a specific note:

slite-sync get abc123

Ask a question across all docs:

slite-sync ask "What are the deployment steps?"

Create a new note:

slite-sync create --title "Sprint Retro 2026-03-01" --content "# Retro Notes\n\n## What went well\n..."

Update a note from a file:

slite-sync update abc123 --file ./updated-doc.md

Multiple Profiles

You can configure multiple Slite workspaces:

slite-sync setup          # Add another profile
slite-sync accounts       # See all profiles
slite-sync use personal   # Switch active profile

Use with AI Coding Agents

slite-sync is designed for AI agents like Claude Code. Agents can use it to:

• Search internal documentation before writing code
• Look up architecture decisions and conventions
• Create or update documentation as part of their workflow

A Claude Code skill is included for automatic integration.

Development

git clone https://github.com/Project-X-Innovation/slite-sync.git
cd slite-sync
npm install
npm run build
npm link          # Install locally for testing
npm test          # Run unit tests
npm run test:e2e  # Run E2E tests (requires configured API key)

License

MIT