Getting started
rypsok is one binary. An agent runtime starts it, or connects to it over
HTTP, and calls three tools: web_search, web_fetch and engine_status.
Install
cargo install rypsok
rypsok --version
Binaries for Linux x86_64 and aarch64 (both static), macOS arm64 and Windows x86_64 are attached to each release, with a container image for Linux x86_64 and one for Linux aarch64. Verify a download before running it:
sha256sum --check --ignore-missing SHA256SUMS
gh attestation verify rypsok-X.Y.Z-x86_64-unknown-linux-musl.tar.gz --repo nabbisen/rypsok
The first proves the file is intact. The second proves where it comes from: the release workflow of this repository built it from the tagged commit. The deployment page says more, and how to load the image.
Run
rypsok serve
With no configuration file, rypsok serves web_search and web_fetch
with the keyless engine, Wikipedia. Logs go to standard error, one JSON
object per line; standard output carries protocol messages only. Stop it
with Ctrl-C or by closing its input.
Check a configuration
The smallest file is the same as no file:
# The smallest file: the same as no file at all. Wikipedia (keyless) is
# active; Brave is configured but inactive until BRAVE_API_KEY is set.
config_version = 1
rypsok check --config rypsok.toml
check says whether the file is valid, prints the effective settings and
each engine with the reason it is inactive, if it is, and exits with 0 for
a valid file, 1 for an invalid one. The file can also be named by the
environment variable RYPSOK_CONFIG.
Where next
- Tutorial 1: your first search takes ten minutes and needs nothing but the binary.
- Reading a response is for the person who writes the prompt of the agent that will call rypsok.
- Troubleshooting when something does not work.