Skip to main content
Builtins catalog / nika:read

File

Tool family from the canonical registry.

invoke

Call this builtin through the invoke verb.

​
Read this contract

This reference preserves the specification at the revision linked below. Source examples are fragments: their surrounding tasks, inputs and permissions are not supplied here. Consult engine status and nika catalog --tools --json for the installed implementation; a registry declaration is not a runtime qualification.

​
Usage and behavior

illustration
Read a file · returns string content (text mode · the default). binary: true (explicit · no content sniffing) returns opaque bytes (04 §value rendering · they flow tool→tool · never into a string position). Throws · NIKA-BUILTIN-READ-001 (file not found, the code the state-file first-run pattern scopes its recovery to) · -002 (IO failure · permission) · -003 (text mode on non-UTF-8 content · use binary: true). All tool_error · transient: false.

Arguments

Pass the values required by the tool contract.

Permissions

Understand authority before granting effects.

Errors and recovery

Read diagnostics and choose a recovery policy.

Workflow templates

Put the fragment inside a complete workflow.

​
Contract provenance

Read the pinned specification · Canonical registry. Tool identity: nika:read. Specification revision: f8c5df2127c7. The Lab language identity is language:tool:read; the registry view is ecosystem:tool/nika:read. They refer to this contract without merging their graph identities.