Product

CLI Reference

The Neenja CLI serves or builds the reader from a documents folder, with legacy support for a single documentation file.

clicommandsworkflow

The CLI is the main external interface for working with Neenja as a tool.

cli command

neenja serve

neenja serve [--dir <path>] [--file <path>] [--private | --public]

Start the local reader UI against a Neenja documents folder.

Parameters
  • --dir <path>: string - Explicit path to a Neenja documents folder.
  • --file <path>: string - Legacy path to one documentation file.
  • --private: boolean - Include private concepts, project plan pages, and task tree pages.
  • --public: boolean - Render only public documentation concepts and omit project plan and task tree data.
Behavior

concepts, project plans, and task trees. plans and task trees.

  • Resolves .neenja/ by default.
  • Recognizes documentation.md, project-plan.md, and task-tree.yaml by filename.
  • Falls back to ./neenja.knowledge.md when no folder documentation file exists.
  • Launches Astro in dev mode.
  • Defaults to showing the full private documentation set, including private
  • With --public, renders only public documentation concepts and omits project

cli command

neenja build

neenja build [--dir <path>] [--file <path>] [--private | --public]

Build the reader as a static site in .neenja/build.

Parameters
  • --dir <path>: string - Explicit path to a Neenja documents folder.
  • --file <path>: string - Legacy path to one documentation file.
  • --private: boolean - Build the full private documentation set, including private concepts, project plan pages, and task tree pages.
  • --public: boolean - Build only public documentation concepts and omit project plan and task tree data.
Behavior

are private developer data. and the source files exist.

  • Uses the same parser and renderer as serve.
  • Resolves .neenja/ by default.
  • Defaults to the public documentation subset so generated static docs can be published safely.
  • Omits project plan and task tree routes in public mode because those files
  • Includes project plan and task tree routes only when --private is passed

cli command

neenja build-github

neenja build-github --domain <url> --page <path> [--dir <path>] [--file <path>] [--private | --public]

Build the reader for GitHub Pages with explicit site and base-path values.

Parameters

and omit project plan and task tree data.

  • --domain <url>: string - Site origin for the generated build.
  • --page <path>: string - Base path under that origin.
  • --dir <path>: string - Explicit path to a Neenja documents folder.
  • --file <path>: string - Legacy path to one documentation file.
  • --private: boolean - Include private concepts, project plan pages, and task tree pages in the build.
  • --public: boolean - Restrict the build to public documentation concepts