Skip to content

docs: clarify onboarding and source installation #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scbrown merged 1 commit into from
Oct 26, 2026
Merged

docs: clarify onboarding and source installation #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
watches and signed-decision client surfaces. It is a static site, not a new
knowledge store. Missing evidence stays UNKNOWN.** Rikuy means “to see” in Quechua.

For a reviewed setup of stack tools, start with [Tambo](https://github.com/intigraph/tambo).
For agent knowledge ingress and vocabulary, see [Camayoc](https://github.com/intigraph/camayoc).
Rikuy deployment and live-reader admission remain separate.

## Why you would want it

- See work and its evidence together instead of copying headlines.
Expand All @@ -25,6 +29,8 @@ static output into `~/.local/share/rikuy/REVISION`:
curl -fsSL https://raw.githubusercontent.com/scbrown/rikuy/main/install.sh | sh
```

See [installer options, manual source builds and removal](docs/book/src/reference.md#installing-and-removing).

Set `STACK_INSTALL_ROOT` on the receiving shell to choose another prefix. No
server, credentials or live connection are configured. Deploy the resulting
static files through your normal site lane. Never include a bearer, private key
Expand Down
28 changes: 28 additions & 0 deletions docs/book/src/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,31 @@
`web/legacy/config.mjs` owns the immutable reader contract and disabled activation. A deployment supplies its exact graph, source/curator/row binding, creation receipt and registered query definitions. No URL or local-storage switch enables a reader. `web/knowledge/config.mjs` and `web/offline/config.mjs` remain disabled independently.

Production endpoints, graph registration, read-cost acceptance, snapshot provenance and signing enrollment must be provided by the deployment owner. The public demo is not their acceptance proof. Do not distribute operator data with this repository.

## Installing and removing

Rikuy currently distributes a source build, not a versioned release package.
The [one-line installer](https://github.com/intigraph/rikuy/blob/main/install.sh) requires Node 22+, npm, Python 3
and Git. It clones the public main branch, runs `npm run build` and copies only
`dist` into `PREFIX/share/rikuy/SOURCE_REVISION`. The default `PREFIX` is
`~/.local`. Its `.source.json` records the source revision and package version;
this is not a release checksum or a claim that a service has been deployed.

Download and review `install.sh` before running it. Set `STACK_INSTALL_ROOT`
on the receiving shell to choose a private prefix; no positional arguments or
version-pin flag are supported. Re-running for an existing revision verifies
the full static tree, file modes and source record and refuses drift instead
of overwriting it.

For a manually selected source revision, use a clean checkout of the public
repository, select the revision you intend to build, then run `npm run build`.
Deploy `dist` through your normal site lane. The installer does not configure
a web server, credentials, Quipu endpoints or live-reader activation.

To remove an installed build, first stop referring to its static files in your
site deployment, then remove only its `PREFIX/share/rikuy/SOURCE_REVISION`
directory. Keep other revisions you still use. Removing static output does not
remove Quipu data or change a separately managed site deployment.

A checksummed release installer remains unavailable until the project publishes
its release package and checksum manifest.
Loading