Rymtech.net / wiki / rym-cli-reference
rym CLI Reference
The full rym command-line reference: node, domain, site, gateway, search, and peer commands.
Last updated 2026-07-12 17:51
What rym is
rym is Rymnet's raw command-line tool: node setup, domain claims, site publishing, peer management, search, and replication. It operates on one node identity at a time (~/.rymnet/, or whatever --data-dir you pass). It does not require rymnetd to be running for most commands — the gateway is only needed to actually serve a published site over HTTP.
Node
| Command | What it does |
|---|
rym init | Create this node's identity keypair. |
rym node id | Print this node's ID. |
rym node status | Show local node status. |
Domains (.rym)
| Command | What it does |
|---|
rym domain search <name.rym> | Check whether a domain is already claimed locally. |
rym domain claim <name.rym> | Claim it as this node's identity. First-come, earliest signed timestamp wins on conflict. |
rym domain info <name.rym> | Show claim details. |
rym domain list | List local claims. |
rym domain renew / release | Prototype stubs, present but not fully wired up yet. |
Sites
| Command | What it does |
|---|
rym site create <domain> | Scaffold a default index.html/style.css under ~/.rymnet/sites/<domain>/source/. |
rym site upload <domain> <folder> | Copy a local folder in as the site source. |
rym site validate <domain> | Check the source is well-formed static HTML/CSS. |
rym site publish <domain> | Validate, hash, chunk, sign a manifest, index for search, and announce to peers — all in one step. |
rym site status <domain> | Show current publish status. |
rym site versions <domain> | List saved manifest versions. |
rym open <domain> | Print the local gateway URL for a domain. |
Gateway
rymnetd run starts the daemon that actually serves published sites over plain HTTP at http://127.0.0.1:7447/<domain>/, re-verifying the claim, manifest signature, and chunk hashes on every request before serving anything.
Search
| Command | What it does |
|---|
rym search <query> | Search the local index. |
rym search --domain <d> <query> | Search filtered to one domain. |
rym search --network <query> | Search using signed search records shared across peers. |
rym index status / rebuild / site <d> / clear | Manage the local search index. |
Peers
| Command | What it does |
|---|
rym peer add <addr> <pubkey> | Add a peer you already know the address and public key for. |
rym peer connect <ip> | Bootstrap from just an IP — exchanges identities and pulls that peer's own peer list. |
Replication
A set of commands (see the source tree's INSTALL_AND_CLI_GUIDE.md for the full list) push and pull site data between peers so a domain stays available even if its origin node goes offline, the same trust-on-first-use model as everything else in Rymnet.