Search documentation

Find guides and API references.

Documentation

Getting started

Prepare Obsidian, validate your SystemSculpt account, and confirm the chat workspace is ready for production use.

Prerequisites

Make sure these basics are in place before you enable the ribbon actions. They match the checks the plugin runs the first time it loads.

  • •Obsidian 1.4 or later (1.5+ recommended) with community plugins enabled.
  • •A SystemSculpt license key for managed services, or API keys for any custom providers you plan to use.
  • •Writable directories for chats, saved chats, recordings, and extractions (configured under Settings → SystemSculpt → Files & Backup).

Install & enable

Start with the official Obsidian community plugin listing, open the settings tab, and finish with the license and provider handshake in that order. Your first chat will load faster when everything is validated up front.

Install from ObsidianCompare paid plans
  1. 1

    Install from the official Obsidian community listing

    Open the official Obsidian community plugin listing for SystemSculpt AI, install it into your vault, and enable “SystemSculpt AI” under Settings → Community plugins. Use a manual .obsidian/plugins folder copy only when you are testing a local build or recovering from an Obsidian listing issue.

  2. 2

    Activate your license & server connection

    Open Settings → SystemSculpt → Overview & Setup, paste your SystemSculpt license key and server URL, then click “Activate” so the plugin can verify the details on the spot.

  3. 3

    Choose your primary model provider

    Enable the curated SystemSculpt catalog or add custom providers (OpenAI, Anthropic, Groq, OpenRouter, LM Studio, Ollama). Use “Test connection” before saving.

  4. 4

    Review storage directories and open the chat view

    Confirm chat, recordings, extractions, and saved notes directories, then launch the SystemSculpt chat ribbon icon to start a conversation.

First sync checklist

Walk through these steps once you are connected. If anything fails, Obsidian will show a notice or log entry so you know exactly what to adjust.

  • •Open the SystemSculpt chat view from the left ribbon and confirm the model indicator shows your preferred model.
  • •Attach a markdown note or document to the drawer and verify a context chip renders above the composer.
  • •Send a prompt to watch streaming responses and, if enabled, approve any tool calls.
  • •Favorite the chat or run /save → Save as Note to make sure your chats directory is writable.

Key settings surfaces

Overview & Setup tab
Host license validation, provider selection, and quick diagnostics you can run any time connection issues appear.
Files & Backup tab
Control where chats, saved chats, recordings, attachments, and extractions are stored so every workflow writes to a known folder.

Need help choosing between monthly billing and the lifetime license before activation? Review Billing & licenses for cancellation and policy details.

Previous

Overview

Next

Billing & licenses