flowverse

The official index of humanize flows: which flows there are, which versions of each, and the exact commit each version is.

This repository holds no flow code. Each flow lives in a public GitHub repository of its own, and this index pins every released version of it to a commit, as winget-pkgs does for winget.

Table of Contents

• Background
• Install
• Usage
• Contributing
• License

Background

One manifest per released version of a flow. A flow of Humanfia's is listed under its name; a flow of anybody else's under the GitHub user or organization that owns its repository, in lowercase:

flows/
├── recursive_lean_prover/          a flow of Humanfia's, by name
│   └── 0.1.0/                      a SemVer 2.0.0 version
│       └── flow.yaml               where that version is
└── alice/                          anybody else's: the owner of its repository
    └── kernel/                     the flow's name
        └── 0.1.0/
            └── flow.yaml

name: recursive_lean_prover
version: 0.1.0
description: Recursively plan, prove, compare, review and catalogue Lean theorems.
repo: humanfia/recursive-lean-prover-flow
ref: v0.1.0
commit: 6cfb688a5a38b51965b641fed8ad7aa063ae197f
subdir: recursive_lean_prover
license: Apache-2.0
dependencies:
  humanize1: ">=0.1.0,<0.2.0"

hmz installs exactly commit, so a version means the same code for everybody, for good. A published version is never edited: a change is a new version. Every field is described in CONTRIBUTING.md, and checked against schema/flow.schema.json.

hmz calls each flow what its directory here says: recursive_lean_prover, alice/kernel, and humanize1:rlcr for a flow inside one. The flows of a flowverse you add yourself are @<flowverse>/<flow> and @<flowverse>/<owner>/<flow>.

The loops humanize is built around (chat, ralph_loop, goal, flame_chase, stateful_ralph, continue_loop, rlar) ship inside humanize itself and are not listed here.

Install

Nothing to install: this index is built into hmz as its official flowverse.

Usage

In hmz, open /flows and go to Flowverses. Pick a flow, pick one of its versions, and install it; installed flows are the ones you can run. hmz keeps the index itself up to date in the background, and tells you when a flow you installed has a newer version.

Your own flowverse. Any GitHub repository laid out like this one is a flowverse, a flows/<flow>/<version>/flow.yaml or flows/<owner>/<flow>/<version>/flow.yaml per release, except that a flow of anybody's may be listed by name alone there. Add it from the same Flowverses page, next to this one. Copy schema/ and .github/ to give it the same checks, setting OWNER in validate.py to whose flows may be listed by name alone, or to None for anybody's.

Warning

Installing a flow runs its code on your machine, and its agents work without asking for approval. Review in this index lowers the risk; it does not remove it. Read Security first.

Contributing

To list your flow, publish it in a repository of your own and open a pull request adding its manifest: CONTRIBUTING.md is the whole guide. A version of a flow already listed, newer than all of its others, that changes nothing but version, ref and commit is merged automatically once every check passes, installing it with hmz among them. Report a malicious flow privately, as SECURITY.md explains. Everyone taking part follows the code of conduct every humanfia repository shares.

License

The manifests, schema and scripts here are Apache-2.0 © Humanfia. Each flow is under its own license, named in its manifest.