Sprig

A small tool for exploring a prose universe.

Installing sprig

npm install -g @sprig-and-prose/sprig

If you don’t have npm, that’s ok. You can learn how to install it here.

Using sprig

sprig --help
sprig compile
sprig ui

Run these inside a directory with a universe.prose file.

This will:

• compile the universe
• open a local UI
• let you explore what you’ve described

What it does

Sprig reads a universe and turns it into something you can inspect.

You can:

• browse concepts
• follow relationships
• view dimensions
• move through the world you described

It does not change the universe. It simply makes it visible.

Getting started

If you want to quickly get up and running, create a directory, and inside it, just run -

sprig init UniverseName

You will have a helpful readme.md and a tiny universe in your universe.prose file to get you started.

The manifest

When you run sprig compile, a manifest is produced.

The manifest is a normalized view of the universe:

• every concept has a stable ID
• every relationship is resolved
• every connection is explicit

It is simple JSON.

Other systems can read it.

The UI

sprig ui

The UI is a local explorer.

It lets you:

• open any concept
• see how it is described
• follow how it connects to others

It reflects the structure of the universe directly.

There are no hidden rules. What you see comes from the manifest.

What sprig is

Sprig is a lens.

It does not define the world. It does not run the world.

It helps you see it.

What comes next

In the next phase, sprig can be used inside other systems.

A small SDK will allow systems to:

• read a universe
• generate simple receipts
• state what they know

For example:

const universe = await sprig.load("./universe.json");

const receipt = universe
  .concept("Chicken")
  .exists();

These receipts can be collected and compared.

The universe stays the same. Different systems respond to it.

Continue

• Read prose to understand the language
• Read docs to see the documentation home

Prose describes a world. Sprig shows how systems respond to it.