Skip to main content
This guide walks through a practical AutoSci project: install the profile, import paper metadata with Crossref, create an idea, record an experiment result artifact, and complete an experiment only after the configured gates are satisfied.

1. Install AutoSci

Start in an empty llmwiki project:
AutoSci writes .llmwiki/profile.json. The profile defines research entity types under directories such as wiki/papers, wiki/ideas, and wiki/experiments.

2. Configure Crossref

Create .llmwiki/config.json with a contact email. Crossref uses it in the polite User-Agent header.
Activate Crossref for the current process:

3. Stage a paper from DOI metadata

The connector stages a typed papers candidate. It does not write live content. Inspect the candidate:
review show prints a draft-content-hash. Approve with that exact value:
If the candidate body changes after inspection, approval refuses and asks you to review again.

4. Start the research workflow

The research workflow moves through paper import, triage, distillation, idea creation, experiment design, and experiment completion.

5. Submit an idea

Create idea.md:
Submit it for the workflow’s current idea-writing stage:
If the current stage is trust-gated and no trusted-write grant is present, the output parks instead of going live. Re-run the same submit with the grant when you want a clean trust-gated write to apply:

6. Record an experiment result artifact

Create result.json:
Write the artifact and save the printed ref:
The command prints a value like:

7. Complete the experiment with a pinned ref

Create experiment.md using the artifact ref:
AutoSci’s experiments lifecycle requires more than a field value before stage: complete is accepted:
  • resultSummary must be present;
  • result must resolve to a healthy experiment-result artifact;
  • the experiment must have a live tests relation to an idea.
Submit or approve the page only after those requirements are satisfied. If any requirement is missing, llmwiki refuses the write or leaves the candidate in review with an actionable error.

8. Export or share the project

JSON export includes a profile block for non-default projects. OKF export records profile identity, relation metadata, and workflow run metadata in the bundle’s x-llmwiki block. Import into another project interprets those records through the active local profile; it does not migrate the receiving project.

Trust model recap

  • Templates install declarative profile data, not code.
  • Crossref fetches external data and stages review candidates only.
  • Connector approval requires the operator-supplied draft content hash.
  • Direct artifact writes require LLMWIKI_TRUSTED_WRITE.
  • Workflow trust gates require LLMWIKI_TRUSTED_WRITE=autosci or * to auto-apply clean writes.
  • Lifecycle preconditions are enforced at write time and reported again on read surfaces if the graph or artifact store drifts later.