Skip to main content
Builtins catalog / nika:edit

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
In-place find/replace · returns the modified path. find: is a literal string (not a regex: use nika:grep to locate · jq to transform) · replaces all occurrences · count: (when set) caps replacements to the first N. count: MUST be a non-negative integer — a present non-integer (e.g. the string "2") is a loud -001 arg error, NEVER silently the replace-all default (that silent fall-through would over-edit the file · the intent-inversion footgun class). Throws · NIKA-BUILTIN-EDIT-001 (find: matched nothing: an edit that edits nothing is an authoring bug · tool_error · also a non-integer count:, and an empty find:, refused before the file is read: it would match between every character and write the replacement between every byte) · -002 (IO failure).

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:edit. Specification revision: 5cd95cd25c0f.

Documentation

Guides, reference contracts and working examples.

Language spec

the nine-key envelope, Apache-2.0. The contract these docs explain.

Engine source

Rust, AGPL-3.0-or-later. Every commit public.

TypeScript SDK

Use one typed lifecycle locally or against authenticated nika serve HTTP.

Editor extension

The editor extension, frozen at 0.120 and not qualified with 0.124: use nika lsp and the JSON Schema.

Homebrew tap

brew install supernovae-st/tap/nika for the latest tagged CLI release.

SuperNovae

The Paris studio crafting Nika. 🦋