Skip to content

docs / getting started

Chapter 01

Getting started

A guided walkthrough from first login to your first agent-made pull request. Follow it in order; each step builds on the last.

~3 min read9 sections

Before you begin

You'll need:

  • An account on a deployed Vyazen instance (if you don't have one, ask whoever set up Vyazen for your team).
  • A repository you can connect, hosted on GitHub, GitLab, or Bitbucket.
  • An account on that source-control service with permission to authorize access.
  • A source-control integration configured on your Vyazen instance. If none is set up yet, see Integrations or ask your admin.

Step 1 — Sign in

Open your Vyazen URL and sign in. You can sign in with email and password, or with Google if your instance has Google sign-in enabled.

Step 2 — Connect your first repository

From the dashboard, connect a repository:

  1. Choose your source-control provider (GitHub, GitLab, or Bitbucket).
  2. Authorize Vyazen to access the repo (follow the provider's approval flow).
  3. Select the repository and the branch you want to work on.

The branch you pick is the workspace — the agent will make its changes there.

note

Not every instance has every provider configured. If you don't see yours, ask your admin to set up the integration.

Step 3 — Wait for indexing

Vyazen now reads your repo and builds the code graph. The dashboard shows a live status for each repository — it moves through stages like queued, running, and finally ready (or failed if something went wrong).

While it runs, Vyazen is mapping your files, extracting symbols and the links between them, and writing AI summaries. Large repos take longer. You don't need to wait at the screen — you'll see ready when it's done.

Step 4 — Tour the wiki (optional)

Once indexing is done, Vyazen has generated a wiki for your repo — an Overview, Getting Started, Architecture, Glossary, and more. Open it from the repository view to get oriented. You can also chat with the wiki to ask questions about your code. See The code wiki.

Step 5 — Create your first task

Now describe some engineering work. From the tasks page, create a task:

  • Pick the repository and branch.
  • Give it a short title.
  • Describe what you want done, as you'd describe it to a teammate. The clearer and more specific you are, the better the result.

The task starts as a draft, then Vyazen provisions an instance to run it.

Step 6 — Watch the agent work

Open the task. The agent starts up and works through the workflow: it researches your code, may ask you clarifying questions, drafts a design, and asks for your approval before implementing. You'll see its progress stream in the chat — plans, tool calls, and any subagents it spawns.

When the agent pauses at an approval gate, respond:

  • Questions — pick one of the options it offers.
  • Design sign-off — approve or request changes to its approach.

The agent won't commit anything until you've approved the design.

Step 7 — Review and approve the pull request

When the work is done and verified, the agent proposes a pull request. You'll get an approval card in the chat to commit, push, and open the PR. Approve it, then review the PR — in Vyazen or in your source-control provider — and merge it. See Reviewing and merging pull requests.

Where next

© 2026 Vyazen · Docs