Revetly
Manual 0.8.0

Your first hour

One path from the handout to a first answer out of what the instance read. There is no choice on it, and no step you can skip.

Before you start

1. Load the engine

  1. Load the tarball for your architecture as a Docker image:

    docker load < revetly-engine-0.8.0-linux-<ARCH>.tar.gz

    Replace <ARCH> with arm64 on Apple Silicon and amd64 on Intel.

    You should see Loaded image: revetly:0.8.0 (as Docker shows it)

2. Scaffold the instance

  1. Scaffold it into the folder your project lives in:

    docker run --rm -v "$PWD:/project" -u "$(id -u):$(id -g)" revetly:0.8.0 revetly init --transport container --group-id your-product

    You should see Instance 'your-product' at /project (container transport, engine revetly:0.8.0)

  2. Start the two services init declared:

    docker compose up -d

    You should see Container revetly-neo4j-your-product Started (as Docker Compose shows it)

3. Read the whole chain back

  1. Ask the engine what it can see, before anything is spent:

    docker compose exec revetly revetly doctor --offline

    [PASS] source roots   docs, sources/backlog, sources/conversations, sources/deliveries

4. Open the configuration page

  1. Print the one address that opens it:

    docker compose exec revetly revetly config

    You should see Open it as it is. …

  2. Open that address in your browser.

    You should see One answer still needed.

5. Give Revetly a key

  1. Read Run an instance with no provider key where you hold no key of your own, and skip to section 6 from there.

  2. Read the one failure a fresh instance reports:

    docker compose exec revetly revetly doctor --offline

    [FAIL] provider key   OPENAI_API_KEY is not set

  3. Enter your own key in the OpenAI API key box.

  4. Select Save.

    You should see Configured and running.

6. Add your first project

  1. Select Add your first project.

    If the page offers to add another project, Troubleshooting below says what to do.

    You should see Name this project.

  2. Enter a short name for this project.

  3. Select Continue.

    You should see Where it lives.

  4. Enter the folder this project is read out of. Leave it empty to keep this project where Revetly was set up.

  5. Select Save and continue.

    You should see Point it at your work.

  6. Copy your documents into the docs folder inside the project folder. Revetly reads that folder and nothing above it.

  7. Leave the sources as they are, then select Save and continue.

    You should see What will this cost?

7. Price and run the first pass

  1. Select Price the first pass.

    If the pass has nothing to price, no document sits in that docs folder.

    You should see Price it again beside the figure.

  2. Select Run the first pass.

    You should see The first pass. You can close this page — it carries on without you.

  3. Select Run it.

  4. Wait for the pass to finish.

    You should see This instance is answering — ask it something through the MCP tools.

8. Ask it a first question

  1. Ask CONTEXT what your documents say about the product: 

    docker compose exec revetly revetly search "what is this product for"

    "source_path": "docs/<YOUR_DOCUMENT>.md",

    Revetly answers in JSON, with the documents that matched under artifacts before the passages and facts.

Troubleshooting

Next steps