Skip to manual content
Orchard Manual
Browse the manual

Orchard · 0.1.0 source manual

Quick start

Read an export first, then make changes only to a copy you intend to edit.

Open an export

Export your data from Ourcana and keep an untouched backup. Use the actual filename in place of ourcana.json below. JSON and .our exports do not need sign-in.

or --store ./ourcana.json info
or --store ./ourcana.json who
or --store ./ourcana.json members
or --store ./ourcana.json history --count 5

For an empty local store, or --json who prints:

[]

That means no live front events were found, not that sign-in failed. Output and scripting explains which commands produce JSON.

Change a local copy

Use a writable JSON or .our copy, not the app's .willowdrop. Replace the names below with members already in your store. Quote names that contain spaces.

or --store ./working-copy.json switch "Alex"
or --store ./working-copy.json switch "Alex" "Sam"
or --store ./working-copy.json --json who

switch closes every live front event and adds a new event for the selected members. Two or more members make a co-front. The change is saved to the same file; this does not update a remote server.

Save a separate export

or --store ./working-copy.json export --format our --output ./backup.our

The output file is written immediately and may overwrite an existing file. Choose a fresh path when keeping a backup.

Connect only when you need a server

Reading a local export and enrolling an identity are independent. A fresh local.device identity is a new system, not a way to sign into your existing app system. Read signing in and pairing before enrolling one for server work.

Use sync servers to configure an endpoint and check the connection. Pairing and connect are not a complete local-store synchronisation workflow.

Search the manual

Search pages and sections. Nothing is sent to a server.