Cinc

@whitemars/cincv2026.07.10.1· 2d agoMODELS

01README

Read-only Chef/CINC server administration via knife: node health status, node detail, search, package inventory, and group/ACL inspection.

02Models1

@whitemars/cincv2026.07.10.1cinc/cinc.ts

Argument	Type	Required	Description
staleHours	number	yes	Hours after which a node is considered stale
criticalHours	number	yes	Hours after which a node is considered critical (no check-in within this window)
knifeConfigPath?	string	no	Path to knife.rb config file
knifeBinary?	string	no	knife executable to invoke (e.g. knife or cinc-knife). Auto-detected when unset: prefers cinc-knife, falls back to knife.

fn status()

Query the Chef/CINC server via `knife status` and return node health

fn show(nodeName: string)

Show detailed info for a specific node via `knife node show`

Argument	Type	Required	Description
nodeName	string	yes	Name of the node to inspect

fn search(query: string, index: string, attributes?: array)

Run a `knife search` query against an index (default: node) and return matching rows

Argument	Type	Required	Description
query	string	yes	Search query, e.g. 'name:web*' or 'policy_group:union'
index	string	yes	Search index (node, role, environment, client, or a data bag name)
attributes?	array	no	Attributes to return for each match (e.g. platform, ipaddress)

fn group(action: enum, group?: string)

List server groups or show a group's members via `knife group` (knife-acl plugin)

Argument	Type	Required	Description
action	enum	yes	'list' all groups or 'show' one group's members
group?	string	no	Group name (required when action=show)

fn acl(objectType: enum, objectName: string)

Show the ACL for a server object via `knife acl show` (knife-acl plugin)

Argument	Type	Required	Description
objectType	enum	yes	Type of object to inspect
objectName	string	yes	Name of the object (e.g. a node name or group name)

fn filter(status: string)

Filter nodes by health status (ok, stale, critical, never_converged)

Argument	Type	Required	Description
status	string	yes	Health status to filter by

fn checkPackage(packageName: string, group?: string, showMissing: boolean, minVersion?: string)

Check if a package is installed on nodes, optionally with version check and group filter

Argument	Type	Required	Description
packageName	string	yes	Package name prefix to search (e.g. openssl, Microsoft .NET Runtime - 10.0)
group?	string	no	Filter by policy group (e.g. deliver, union)
showMissing	boolean	yes	Also list nodes missing the package
minVersion?	string	no	Minimum required version (e.g. 10.0.9). Nodes below this are 'outdated'