First steps

Welcome to Lyriks. The installation is done, well played!

This page first helps you check that everything went well, then shows you what you can do with Lyriks.

1

Check your installation

Two checks, once. Tick one when it is good: the next opens by itself.

0 of 2 checks done

  1. In Lyriks, open the Versions page:

    Your initialsLyriks settingsAccount settingsVersions

    Green is what you want, and grey is fine: on a Community install, Lyriks-back and the DPO engine read “Not configured”, because they are Enterprise components.

    A card reads something else? The FAQ explains every status.

  2. Lyriks exposes an MCP server at the address of your installation, the one you open in the browser, followed by /mcp. Add it once to the agent you already code with:

    https://<your-installation>/mcp

    Replace <your-installation> with the address of your Lyriks, the one you open in the browser.

    Which client do you code with?

    Claude Code
    claude mcp add --scope user --transport http lyriks https://<your-installation>/mcpthen /mcp to sign in.
    Codex
    codex mcp add lyriks --url https://<your-installation>/mcpthen codex mcp login lyriks
    Any other client
    an HTTP MCP server named lyriks at the address above. Most clients read their configuration only at startup: restart yours.

    Or let your client do it itself. Paste this into it:

    Prompt Add the Lyriks connector
    I want to connect Lyriks to this conversation. Lyriks exposes an MCP server
    at this address: https://<your-installation>/mcp
    
    Add the connector yourself if you can. Otherwise tell me exactly where to
    click or what to paste in the application I am using right now, and whether
    it has to be restarted. Then list the Lyriks tools you can see.
    
    If the address does not answer, give me the exact error rather than a guess.

    Then, in that agent, check that it can really act on Lyriks:

    Prompt Test the connector
    Create a project named "MCP Test" in Lyriks, then list the projects of the
    portfolio and tell me whether "MCP Test" is in it.

    The agent confirms the creation, and the project appears in your portfolio. Delete it once you have seen it.

    A test project created from the agent, showing up in the portfolio. Lyriks v0.9.

    It does not work? The FAQ lists what goes wrong.

2

Working with Lyriks

Four steps, in the order you run them. Whatever you launch from your agent lands in the interface: that is always where you read the result. Each one carries the prompt its demo types: what sits in braces is yours to fill, starting with {project}, the name your project has in Lyriks.

1

Get your specification out of your codebase

Lyriks does not read your repository: your coding agent does, from inside the repo, and writes the specification into Lyriks through the connector. You have nothing to write.

The specification written from an existing repository. Lyriks v0.9.
Prompt Write the specification from the code
With the help of the Lyriks MCP, ingest this entire codebase into the Lyriks
project {project}.
  1. In the portfolio, New project, then From a codebase. Lyriks hands you one line to paste, with the project already named in it.
  2. Open your agent inside the repository (Claude Code, Codex, Gemini CLI, Copilot) and paste that line. On the first run it asks you to sign in to Lyriks in your browser.
  3. Come back to the project. The sections fill in as the agent authors them, and it asks you only for the decisions your sources cannot settle. The wait is your agent's, not a job running somewhere in Lyriks.
  4. You can finally read what your software does, and why. Its intents, its business rules, its constraints, and the points the code alone could not settle.

The line stays on the project's Kickoff page, one click from Foundation, so you can hand it to another agent later.

2

Read what it found in your product

The project opens on Foundation, and the left column holds the rest: Users & Permissions, Features, Experience, Data & Architecture, Glossary. Evolution is not one of them: it is a tab inside Features, beside the tree it changes. Open a feature to see its intent, its rules and what depends on it.

Walking the specification, from the product down to a single rule. Lyriks v0.9.
Prompt Ask the specification a question
Using the Lyriks MCP, tell me what the specification of {project} says about
the coherence score: what it measures, and where to start raising it.
  1. Read the scores at the foot of that column. Coherence is how free of contradictions the specification is, Coverage what is present, Build readiness whether there is enough depth to build on.
  2. Click a score to open the Control Center. Every issue is listed there, the worst first, each with the place to fix it.
  3. Take the contradictions before the gaps. A contradiction distorts everything that rests on it; a gap only limits what is covered.
  4. You stop digging through the code to find out why a rule exists. The answer, and everything that depends on it, is a few clicks away.
3

Ask for a change, and read what it moves

A change stays apart from the specification until it is built and verified. Lyriks calls it an evolution, and it is made in features that already exist: whatever new it needs shows up in the impact report, never as a feature you create by hand.

An evolution created on the features it touches. Lyriks v0.9.
  1. Features, its Evolution tab, then New evolution. Say the change in one sentence, then pick the features it touches.
  2. Sign the values. Five questions per touched feature: objective, problem, value, measurable effect, acceptance criteria. The assistant proposes an answer with its sources; you accept it, reword it or refuse it, and accepting writes it on the feature.
  3. Compute the impact report. Three readings, never merged into one: if we add it, if we change it, if we remove it. Removing does not break what adding breaks.
  4. You know what the change costs before a line of code is written. The rows marked direct are the work itself. The knock-ons have nothing to edit, they merely rest on what changes, so they have to be re-read, re-run or re-approved: that is what breaks quietly.
What moves if the change ships, read under the three hypotheses. Lyriks v0.9.
Prompt Open the change
In the Lyriks project {project}, open an evolution for this change: {change}.
Tell me which features it touches and what it will ask me to sign.
Prompt Compute the impact
Compute the impact of the evolution {name} in the Lyriks project {project},
and give me the three readings rather than one number.
4

Build it, then verify it

Here the specification is the authority and the model executes. That is what makes models interchangeable, and what often lets a more modest one do the job: most of an LLM's mistakes come from having to guess the intent.

From the signed evolution to the code, then back to Verify. Lyriks v0.9.
  1. Freeze the specification into a version, then ask your agent to implement the evolution.
    Prompt Build the evolution
    Implement the evolution {name} of the project {project} in Lyriks, strictly
    respecting the values signed on it. If a decision is not settled there, stop
    and ask me rather than choosing.
  2. It stops and asks whenever the evolution left a decision open, instead of improvising one.
  3. Verify: the code against the frozen specification, one line per expectation, each one yours to decide. A line you refuse comes with a brief you copy straight back to the agent.
  4. What ships is what you signed, and the gap between the two is a list you read, not a surprise in production.
3

Any question?

The questions that come up most often, and where to reach us.

FAQ

Where do I start?

The two checks above, then point your agent at an existing repository to write its specification. It is the first visible result, it asks you to write nothing, and the rest follows from it.

A card on the Versions page is not green

On a Community install, two cards read “Not configured”, and that is correct. Lyriks-back and the Lyriks DPO engine are Enterprise components: a Community install ships without them, so there is nothing to reach.

Two grey statuses mean the same on both editions. “Recorded at install” is your machine, as described during the installation, and “Unknown” is a component that has not reported its version yet, like the engine before its first use.

“Unreachable” is the one to report. Tell us which card it is, with a feedback or at support@lyriks.io.

My agent does not see Lyriks, or every write is refused

No Lyriks tool at all. Check that the address is the one of your installation followed by /mcp, then restart the client: most of them read their configuration only at startup.

The tools are there, but every write is refused. By default, Lyriks blocks what an LLM proposes. Allow it for the workspace in Settings → AI suggestions, then run the test again.

A licence error comes back. See the activation key.

My activation key is not accepted

Check first that you pasted the whole key, line breaks included: that is the most frequent cause. On an installation without network access, use the offline activation: the verification happens locally. If you never received the key, write to support and mention the address you requested it with.

Does my code leave my machine?

No. Lyriks is installed on your side and never calls an AI service itself: there is no AI key to give it. Everything an AI does here goes through your own agent, over the connector, and only if you allow it: writes coming from an LLM are refused until you turn them on in Settings → AI suggestions.

Which LLM should I use? Am I locked in?

The one you prefer, as long as your client speaks MCP. The intent is carried by the specification, not by the model, so you can change models without losing anything. And a complete specification often lets you settle for a more modest one.

My coherence score is low, where do I start?

Open the Control Center: the issues are listed worst first, each with the place to fix it. Take the contradictions before the gaps, and ask your agent to explain an issue rather than guessing what it means.

The code moved on my side, is my specification still right?

Coherence does not answer that: it measures the specification against itself. The specification against the code is read in two places, the Verify report of an evolution and the implementation percentage carried by each feature. Ask your agent to re-read the code and record where each rule now lives; what it then reports as a gap is the information you are after.

I want to talk to someone

Write to support@lyriks.io with three things: your Lyriks version, the exact error message if there is one, and what you were trying to do. With those three we can answer usefully from the first message.

Leave us feedback

Lyriks is young. A bug, a step that reads badly, an idea: we read everything, and it is what moves the product forward.

A problem, a suggestion?

Tell us what is blocking you or what you are missing, even in one sentence.

Do you like Lyriks?

Give us a star on GitHub. It takes two seconds, and it helps us a lot to get known.

Lyriks version v0.9 · Last updated 21 September 2026 Back to top