Skip to content

Install and Load

Leonard Ramminger edited this page Aug 31, 2026 · 1 revision

Install and Load

Install flow

  1. Parse YAML with validation.
  2. Compile to Protobuf bytes.
  3. Write ~/.config/ycallr/apis/<name>.pb (native install paths).

Source YAML may live anywhere. Install accepts a file path, expands ~, and resolves .yaml / .yml when the extension is omitted.

The profile name comes from the YAML name: field, not only the file stem.

Load flow

At runtime, only compiled .pb profiles are loaded:

  • Native: load_installed_profile(name) reads from the config directory.
  • FFI: ycallr_load_installed(name)
  • WASM: loadInstalled(name) or YcallrApi.fromProto(bytes)

If .pb is missing, callers receive an error that suggests running install.

profile_store API

Function Purpose
compile_yaml_str YAML string to protobuf bytes
install_profile Compile and write .pb
load_installed_profile Load by installed name
load_from_proto_bytes Load from in-memory bytes

CLI install

ycallr install ~/.config/ycallr/apis/github.yaml
ycallr install ./examples/github_api.yaml

See the ycallr-cli wiki for terminal usage.

Clone this wiki locally