Open Knowledge CLI Documentation
Frontmatter5 fields
type
Command Documentation
title
openknowledge list
description
Inspect a knowledge-base tree and machine-readable inventory.
timestamp

openknowledge list

Print a bundle tree of Markdown documents and assets. The output also contains validation context.

Usage

okn list [key-or-path]
okn list --depth 2 Wiki
okn list --json Wiki
OptionDefaultDescription
key-or-path.Registry key or bundle directory.
--spec <version>latestOKF version.
--depth <n>0Maximum tree depth. 0 is unlimited.
--jsonoffPrint the v1 inventory contract.

Text output shows the first validation issue for each affected Markdown file. It identifies non-Markdown files as assets. A folder stays visible at the depth limit when it contains deeper entries.

JSON output contains schemaVersion, the resolved root, and a path-sorted entries array. Each entry contains all validation issues. The list.schema.json file defines the contract.

project-memory/
|-- agents/
|   `-- default.md  Agent Entrypoint  Default Agent Guide
|-- assets/
|   `-- logo.txt  asset
|-- index.md  index
`-- log.md  log
Powered by OpenKnowledge.sh