User guide
Overview
Everything you need to use Vyazen, from your first task to a merged pull request.
What Vyazen Is
Vyazen makes AI coding agents context-aware of your codebase. You connect a repository; Vyazen reads it and builds a searchable understanding of your code: files, symbols, the links between them, and an AI summary of each part. You then describe engineering work, and an agent carries it out on a branch with that full context, pausing to ask questions and get your approval before opening a pull request.
Who This Guide Is For
Developers and team leads who use a Vyazen instance to delegate engineering work to AI agents. This guide assumes you already have an account on a deployed Vyazen instance. If you don't, ask whoever set up Vyazen for your team for access.
Start Here
New to Vyazen? Follow the Getting started guide to connect your first repository and ship your first agent-made PR.
The Journey at a Glance
Vyazen reads your code and builds the code graph
auto-generated pages with chat and search
describe the work in plain language
researches, plans, and implements on a branch
you approve; Vyazen opens the PR
Table of Contents
Getting started
- 01 - Getting started: connect a repo and ship your first PR, end to end
Concepts
- 02 - How Vyazen works: the mental model: the code graph, tasks, instances, agents, and the workflow
Core workflow
- 03 - Connecting repositories: connect a provider, pick a repo and branch, and get it indexed and ready
- 04 - The code wiki: auto-generated pages, chat, and search over your codebase
- 05 - Creating and running tasks: create a task, follow the instance lifecycle, and control a running agent
- 06 - Working with the agent: answer questions, approve designs, and steer the agent through its gates
- 07 - Reviewing and merging pull requests: review the agent's commits and merge the pull request on your provider
Feature reference
- 08 - Databases: connect a Postgres database and see its schema visualized as a graph
- 09 - Integrations: source-control managers and OAuth providers that plug Vyazen into your stack
- 10 - Account & admin: your account, organizations, members, and the admin controls
Reference
- 11 - Glossary: short definitions for every term used in this guide
- 12 - FAQ & troubleshooting: common questions and fixes for when something doesn't behave as expected
How to Read This Guide
Read 01 through 07 in order for the complete journey. To look something up, jump straight to the relevant reference doc. Each one stands on its own, with links back here and into the glossary for any unfamiliar term.
Next: Getting started →