API & CLI / Get started
Run the check where the failure lives.
Use the terminal directly, or install the Skill in your Agent environment.
Terms on this page: Evidence is the single JSON EvidenceBundle that a CLI or Agent run writes to stdout: observed facts, explicit unknowns, policy decisions, and redaction notes. Bounded means each check has a fixed scope, time limit, and size limit, and changes nothing on your system.
Use the GitHub v0.3.0 prerelease tarball URL through npm exec. No global
install. The release requires Node 24. npm published as netokay@0.3.0; remains a separate
release state.
The bundled Skill manifest binds its exact artifact and SHA-256; public release objects
and human acceptance remain separate. The CLI writes one schema-valid EvidenceBundle to
stdout. The command is read-only and accepts one public http:80 or
https:443 target.
Use NetOkay with an agent
Install the Skill. Give it one target.
The website passes the install source, host, and target; the Skill performs the diagnosis.
Public artifact: Agent handoff uses the exact v0.3.0 artifact selected by the ready release manifest. Public commit/tag/prerelease assets, real host calls, and human acceptance remain separate evidence. Do not automatically download, install, or fall back to an incompatible artifact.
Source contract: continue only when capabilities include
agent_host_context_v1 in the netokay version JSON array.
- Codex and Claude Code required hosts for source acceptance.
- Cline optional compatibility; it does not block the required hosts.
The installable Skill is the execution source of truth. Read the Agent handoff contract for host and release boundaries.