# Neith Linux Interface Reference

Reference guide for the currently implemented operational interface surface of
`@neith/linux`.

## Interface Model

`@neith/linux` does not currently expose a JavaScript package API through
`exports`. Its public interface is operational:

- Nx targets from `project.json`
- package scripts from `package.json`
- Nix flake outputs
- ISO definitions and NixOS module entry points
- Cargo workspace entry points for the implemented crates

## Nx And Script Entry Points

The supported workspace targets are:

- `build` for Cargo release builds
- `test` for Cargo test execution
- `lint` for `cargo clippy`
- `fmt` for `cargo fmt`
- `nix-check` for fast flake validation
- `build-iso` for ISO materialization

These same interfaces are reflected in `libs/neith/linux/package.json`.

## Nix And Image Interfaces

The primary machine-consumable Nix interfaces are:

- `flake.nix` as the top-level Neith Linux flake
- `iso/default.nix` for full, minimal, and recovery image composition
- `packages/flake.nix` for package collection outputs
- `modules/neith/*.nix` for workstation, service, update, and rollback policy

Consumers should treat these files as the supported configuration and build
interfaces for the current Phase 52 Neith Linux footprint.

## Cargo Workspace Interfaces

The Cargo workspace root at `Cargo.toml` defines the current Rust entry points
for:

- distro/bootstrap behavior
- package management and overlay handling
- update-agent and rollback support
- services, installer, and system capability crates

These crates are part of the operational platform surface rather than a single
stable library API.

## Stability Notes

- The Neith Linux interface is currently optimized for workspace operation and
  self-hostability validation, not third-party SDK embedding.
- Operational entry points are documented here so downstream automation and
  platform operators know which interfaces are intended to be used directly.
- If `@neith/linux` later grows a formal exported library API, this reference
  should expand accordingly rather than replacing the operational view.

## Related Documentation

- [Neith Linux Overview](../README.md)
- [Neith Linux Developer Guide](../developer-guide.md)
- [Neith Linux User Guide](../user-guide.md)
- [Neith API Documentation Hub](../../api/README.md)
