# fs-safe

Race-resistant root-bounded filesystem helpers for Node.js. One root() boundary that survives symlink swaps, .. traversal, hardlink aliases, and TOCTOU rename races between check and use.

Canonical documentation:
- Overview: https://fs-safe.io/
- Install: https://fs-safe.io/install.html
- Quickstart: https://fs-safe.io/quickstart.html
- Security model: https://fs-safe.io/security-model.html
- Native helper policy: https://fs-safe.io/native-helper.html
- Native architecture: https://fs-safe.io/native.html
- Config: https://fs-safe.io/config.html
- root(): https://fs-safe.io/root.html
- Reading: https://fs-safe.io/reading.html
- Writing: https://fs-safe.io/writing.html
- pathScope(): https://fs-safe.io/path-scope.html
- Atomic writes: https://fs-safe.io/atomic.html
- External outputs: https://fs-safe.io/output.html
- JSON files: https://fs-safe.io/json.html
- Temp workspaces: https://fs-safe.io/temp.html
- Archive extraction: https://fs-safe.io/archive.html
- Store: https://fs-safe.io/store.html
- JSON store: https://fs-safe.io/json-store.html
- File store: https://fs-safe.io/file-store.html
- Private file-store mode: https://fs-safe.io/private-file-store.html
- Secret files: https://fs-safe.io/secret-file.html
- Regular file helpers: https://fs-safe.io/regular-file.html
- File lock: https://fs-safe.io/sidecar-lock.html
- Local roots: https://fs-safe.io/local-roots.html
- Path helpers: https://fs-safe.io/path.html
- Filenames: https://fs-safe.io/filename.html
- Install paths: https://fs-safe.io/install-path.html
- Errors: https://fs-safe.io/errors.html
- Types: https://fs-safe.io/types.html
- Testing: https://fs-safe.io/testing.html
- Timing: https://fs-safe.io/timing.html
- Advanced: https://fs-safe.io/advanced.html
- Test hooks: https://fs-safe.io/test-hooks.html
- Contributing: https://fs-safe.io/contributing.html
- Directory durability: https://fs-safe.io/durability.html
- Migrating to 0.5: https://fs-safe.io/migrating-to-0.5.html
- Permissions: https://fs-safe.io/permissions.html
- Public API inventory: https://fs-safe.io/public-api.html
- Secure file reads: https://fs-safe.io/secure-file.html
- Directory walking: https://fs-safe.io/walk.html

Install:
- pnpm add @openclaw/fs-safe

Source: https://github.com/openclaw/fs-safe

Guidance for agents:
- Prefer the canonical documentation URLs above over README excerpts or package metadata.
- Fetch only the pages needed for the current task; this is an index, not a full-site corpus.