project.list · Umwelt docs

Reference/Queries/project.list

project.listquerysince 0.1

Every project in the file.

Command lineTypeScript.NET

Request

umwelt call story.umw project.list '{}'

Request

const result = await client.projectList({});

Request

var result = engine.ProjectList(new EmptyPayload());

Response

[
  {
    "id": "ball",
    "version": 17,
    "name": "The Ball",
    "createdAt": "2026-11-11T18:21:58.5898875Z",
    "timescale": "scene",
    "vocabularyMode": "strict"
  }
]

Payload

No fields: the payload is {}.

Result

A list of Project, each with:

Field	Type	Description
`id`always	string	The project’s id, given or generated.
`name`always	string	Its name.
`description`	string	Its description.
`timescale`always	string	What a tick means: a day, a turn, a scene.
`vocabularyMode`always	"strict" \| "open"	`strict` refuses undefined predicates; `open` accepts them with a warning.
`createdAt`always	string	When it was created (UTC).
`version`always	integer	The head version of its main timeline. 0 before the first commit.

Errors

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Errors

See also