Skip to main content
This tutorial takes you from an empty terminal to a searchable, source-grounded wiki. You need Python 3.12 or later, a browser, and a folder containing a few documents.
The first-use path runs from install and sign-in through create, link, upload, job, search, and read.

​
1. Install and sign in

1

Install the CLI

If almanac is not found, run uv tool update-shell, open a new shell, and try again. See Install the CLI for details.
2

Set up Almanac and sign in

Setup installs short Almanac instructions for supported coding agents, then opens browser sign-in when needed. It does not create a wiki or upload files.
1

Choose your Organization

Copy the Organization slug from the output. Every Organization has exactly one Wiki, so choosing the Organization also chooses its Wiki. If you have not created an Organization yet, finish browser setup first. The examples below use acme.
The Almanac browser onboarding screen presents a short path from Organization setup to adding source files and reading the resulting Wiki.

Browser onboarding creates the Organization and its Wiki together before you add sources.

2

Link this project to the Organization

Almanac writes .almanac.yaml. Commit this small file so teammates and agents in the repository inherit the same Organization context.

​
3. Upload your sources

1

Upload your source folder

Almanac accepts the source files and starts processing them:
2

Verify the source library

Processing continues after upload returns. Browse the source tree and then search the Wiki to verify that the material is available.

​
4. Search and read the result

Use a short phrase you know appears in one of your uploaded documents. The example below uses vacation policy; replace it with your own phrase.
1

Search and read the result

Search prints extensionless page paths. Copy one path from the result, then assign it below:
--sources adds the evidence connected to the page.

​
You are done when

You can search the Organization’s Wiki, read a generated page, and trace that page back to an uploaded source. The result is a hosted wiki—not a local build artifact.

Learn the product model

Understand sources, pages, and citations.

Choose an integration

Use the CLI from a person, coding agent, or automation.