Getting Started
1 Registration
Start by creating an account to manage your projects and API keys.
- Go to Sign Up
- Enter your details and verify your email
- Access your dashboard immediately
2 Creating a Project
Add your content source to let Yavy index it.
- Navigate to the Dashboard
- Click New Project
- Add your content source: a website URL (e.g.,
https://docs.example.com), GitHub repository, Notion workspace, or Confluence space - Yavy will automatically discover and index your content
3 URL Discovery & Indexing
We automatically discover and index all your content.
Discovery
We automatically find all pages from your content source.
Indexing
Content is processed and optimized for semantic search.
4 Search Your Docs
Install the Yavy CLI to search your indexed documentation directly from the terminal.
$ npm install -g @yavydev/cli
$ yavy init
✓ Setup complete
$ yavy search "how do I get started?"
See the CLI documentation for all available commands.