Skip to content

rc-env.sh

Dynamic Environment Bootstrap — Portability Hardening

Browse Docs pages

Overview

Dynamic Environment Bootstrap — Portability Hardening

Source: bones/scripts/rc-env.sh.

Usage

Not documented in the script help block. Consult the source; no command behavior is inferred.

Options

Not documented in the script help block. Consult the source; no command behavior is inferred.

Examples

Not documented in the script help block. Consult the source; no command behavior is inferred.

Exit codes

Not documented in the script help block. Consult the source; no command behavior is inferred.

Reads and writes

Environment: reads ARCHIVE_DIR, ASSETS_DIR, BONES_DIR, BOOK_REPORT_DIR, CONFIG_DIR, CONTENT_DIR, DOCS_DIR, HELP_DIR, INPUT_FORMAT, LAYOUT_STYLE, LOG_DIR, META_DIR, OUTPUT_DIR, RELEASE_DIR, RENDER_PROFILE, REPORT_DIR, ROOT_DIR, SCRIPT_DIR, TEMPLATE_DIR, TMP_DIR, WEB_DIR (canonical via rc-env.sh / rk_load_env); overrides RK_OLIVER_BIN, RK_RENDERER, ROTKEEPER_VERSION when set.

Working directory: No CWD assumption — all paths are root-relative via ROOT_DIR/BONES_DIR/CONTENT_DIR/etc. derived from rc-env.sh; helpers rk_canonical_path/rk_canonical_or_raw resolve symlinks/portably.

Inputs and outputs: internal environment library reached through rk_load_env, not a dispatcher command. Derives the canonical paths from BASH_SOURCE and configuration, exports the layout/renderer variables, and does not write files. Reuses a paths cache only for the same root in normal mode; init bootstrap ignores it and derives paths from the physical root and active layout. Relocation invalidates normal-mode caches with a warning. Unsupported input/profile values fall back to Markdown/HTML. ROTKEEPER_ENV_LOADED makes repeated loading for the same root idempotent; FORCE_ENV_RELOAD is reserved for init after cache writes. Strict validation in rc-utils rejects corrupted caches or escaping paths.

Side effects

No side effects are documented in script annotations.

Notes

Design

Internal Bash library loaded through rk_load_env, not a dispatcher command. Derives the repository root from its own location and keeps system paths under bones. Crypt uses home/content, bones/templates, home/assets, and output; busy changes templates/assets to root directories; sterile uses src/content, config/templates, src/assets, and dist. It exports paths and configured source/output-format settings without writing files.

Limits

Normal commands reuse a serialized paths block only when its saved root equals the physical root, and export from it only one-line string values under the path keys init writes; shared strict validation rejects any other entry as a corrupted cache. A relocated cache is ignored during derivation with a warning, but shared strict validation still rejects the saved configuration. Init bootstrap always ignores the cache and rederives all destinations from the root and YAML layout before validating them. Normal repeated loads for the same root return early unless forced; editing configuration does not automatically refresh variables in an already-loaded shell. Unsupported input formats and render profiles fall back to Markdown and HTML.

Cautions

Callers should source rc-utils.sh and initialize through rk_init_script, rather than bypassing shared validation with a direct environment load. Path derivation and strict validation are separate: deriving paths does not prove their readiness or cache coherence. Init uses FORCE_ENV_RELOAD=true after writing mappings; normal callers should not use that override to mask stale configuration.

History

[0.4.0.4] - 2026-07-01

[0.4.0.5] - 2026-07-01

[0.4.0.2] - 2026-06-30

[0.4.0.3] - 2026-06-30