Getting Started
Learn how to use ultrasync for semantic code search and memory
Welcome to ultrasync
ultrasync provides semantic code search and persistent memory for AI coding agents. Get sub-second lookups and maintain context across sessions.
Quick Start
Installation
Install the ultrasync MCP server to enable semantic search in Claude Code:
uv tool install ultrasync-mcp
claude mcp add ultrasync -- uv tool run --from ultrasync-mcp ultrasync mcpBasic Usage
Once installed, ultrasync automatically indexes your codebase and provides:
- Semantic Search: Find code by meaning, not just keywords
- Persistent Memory: Context that survives across sessions
- Symbol Extraction: Quick access to functions, classes, and types
Note that ultrasync is designed to work seamlessly with Claude Code, and
includes prompt hints that should automatically enable the use of search()
during normal usage. However, when using ultrasync outside of Claude Code,
you may need to manually invoke the search() function.
The search() function is also equivalent to running the query command
from the CLI, e.g.
ultrasync query --query-text "authentication logic"Features
Semantic Code Search
Search your codebase using natural language queries:
search("authentication logic")
search("error handling patterns")
search("database connection setup")Memory System
Store and retrieve context across coding sessions:
- Design decisions
- Debugging findings
- Architecture constraints
- Implementation notes
Convention Tracking
Discover and enforce coding conventions automatically extracted from your codebase.
Next Steps
- Installation Guide - Detailed setup instructions
- Configuration - Customize ultrasync for your project