Quick start
Get up and running with Rescriptum in under 3 minutes.
This guide walks you through opening your first project, configuring your model credentials, running an autonomous agent task, and verifying code edits.
1. Launch & Enter API Key
Download and launch rescriptum.exe. On first launch, Rescriptum will prompt for your OpenRouter API key. You can create one at openrouter.ai/keys. Your key is stored locally in your system configuration directory and never sent to secondary servers.
2. Open a Workspace
Click **Open Folder** or press Ctrl+O to select your project directory. Rescriptum automatically indexes your codebase symbols, detects your build system, and prepares the project context.
3. Select a Chat Mode
In the chat header, choose your operating mode:
- **Ask**: Fast, read-only answers without tool execution.
- **Agent**: Full autonomous loop (default) with edits, terminal execution, and build verification.
- **Plan**: Deep reconnaissance that produces a structured
plan.mdwithout modifying code. - **Build**: Focused implementation mode tailored to execute previously approved plans.
4. Run an Agent Task
Type a clear, outcome-focused prompt, for example:
"Add rate limiting to the API routes: sliding window, 100 req/min per IP, and ensure all tests pass."
The agent will inspect relevant symbol definitions, apply precision diffs, run your test suite, and verify that the build remains clean.
5. Review & Verification
Every file change appears directly in the editor with inline diffs. If an edit fails compiler verification, Rescriptum's auto-revert gate automatically restores the last green checkpoint so your working tree is never left in a broken state.