alee/relicario
1
0
Fork 0
Code Issues Pull Requests 8 Actions Packages Projects Releases Wiki Activity

docs(user): fix getting-started blockers (add git prereq + git clone command) + clarify sync remote setup

Browse Source
This commit is contained in:
adlee-was-taken
2026-06-20 22:30:07 -04:00
parent df488a3d7c
commit 59ebc28e7e
2 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
user_docs/getting-started.md
View File

@@ -6,9 +6,21 @@ This page walks you through building Relicario from source, creating your first
## 1. Build and install the CLI
Relicario is currently distributed as source code, so you will need the Rust toolchain (`cargo`) installed. If you do not have it yet, visit [rustup.rs](https://rustup.rs) and follow the instructions there.
Relicario is currently distributed as source code, so you will need two tools installed first:
Clone the Relicario repository, then build the CLI:
- **git** — used to clone the source now, and to sync your vault later. If you don't have it, see [git-scm.com/downloads](https://git-scm.com/downloads).
- **The Rust toolchain** (`cargo`) — if you don't have it yet, visit [rustup.rs](https://rustup.rs) and follow the instructions there.
Clone the Relicario repository and move into it:
```bash
git clone ssh://git@git.adlee.work:2222/alee/relicario.git
cd relicario
```
> Substitute the URL of whichever Relicario repository you were given access to.
Then, from the project root, build the CLI:
```bash
# Fast debug build (good for trying things out)

2
user_docs/sync-and-backup.md
View File

@@ -12,7 +12,7 @@ Relicario stores your vault in a git repo. Every item you add, edit, or delete i
relicario sync
```
Under the hood, this does a `git pull --rebase` followed by a push to your configured git remote — the same remote you set up when you initialized your vault. Any machine that has the vault cloned and a copy of your reference image can sync and stay up to date.
Under the hood, this does a `git pull --rebase` followed by a push to your configured git remote. Your vault is a normal git repository, so you add its remote yourself the usual way — for example, from inside the vault directory, `git remote add origin <your-server-url>` (a self-hosted Gitea/GitHub repo, or any git host you control). Once a remote is configured, any machine that has the vault cloned and a copy of your reference image can `relicario sync` and stay up to date.
**Check what's in your vault at a glance:**