From 0951ba18e159619325359cf27a09a34c95e6963c Mon Sep 17 00:00:00 2001 From: Sausage Agent Date: Fri, 16 Oct 2026 20:55:39 +0000 Subject: [PATCH] README: run straight from the public URL (nix run git+https://...), clone optional --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 786ea24..55012ba 100644 --- a/README.md +++ b/README.md @@ -11,24 +11,23 @@ change its own code. ## Start You need [Nix](https://nixos.org/download) with flakes, and an API token for -an LLM (OpenAI Responses or Anthropic Messages API). +an LLM (OpenAI Responses or Anthropic Messages API). No clone needed: ```sh -git clone https://gitea.surma.technology/surma/sausage && cd sausage -nix run -- init # creates ./world and builds the agent (a few minutes) -nix run -- run # starts the world and a console +nix run git+https://gitea.surma.technology/surma/sausage -- init # creates ./world and builds the agent (a few minutes) +nix run git+https://gitea.surma.technology/surma/sausage -- run # starts the world and a console ``` `init` asks for the API shape (`openai-responses` or `anthropic-messages`), the base URL, the model, and the token. It reads `SAUSAGE_API`, `SAUSAGE_BASE_URL`, `SAUSAGE_MODEL`, and `SAUSAGE_API_TOKEN` first. The values go to `world/actor/agent/data/config.json`. Both commands take another -folder as an argument, for example `nix run -- run my-world`. +folder as an argument, for example `... -- run my-world`. To keep a world on the newest version, run it in a loop: ```sh -nix run .#loop -- my-world +nix run git+https://gitea.surma.technology/surma/sausage#loop -- my-world ``` The loop runs `nix run --refresh git+https://gitea.surma.technology/surma/sausage -- run my-world`. @@ -36,6 +35,9 @@ When the host crashes or an actor sends `@broker {"type":"exit"}`, the loop fetches the newest commit and starts it again. `/quit` ends the loop. Set `SAUSAGE_FLAKE` to run another flake URL instead, for example your fork. +From a clone (`git clone https://gitea.surma.technology/surma/sausage`), the +same commands are `nix run -- init`, `nix run -- run` and `nix run .#loop`. + In the console: ```text