Open Knowledge CLI Documentation
Frontmatter5 fields
type
Command Documentation
title
openknowledge scaffold
description
Create a deterministic minimal Open Knowledge bundle.
timestamp

openknowledge scaffold

Create bundle files. The command does not start an agent or install project integration. For managed onboarding, use the agent-guided okn setup task.

Usage

okn scaffold [folder]
okn scaffold --name "Project Memory" ./project-memory
okn scaffold --no-agents --no-setup ./source-wiki
OptionDescription
folderDestination. Defaults to a slug derived from the name.
--name <name>Display name. Prompts when omitted.
--bundle-name <id>Stable okf_bundle_name.
--bundle-title <title>Display okf_bundle_title.
--bundle-purpose <text>okf_bundle_purpose.
--bundle-tag <tag>Add a bundle tag. Repeatable.
--bundle-entry <name=path>Declare an entrypoint. Repeatable.
--no-agentsOmit starter AGENTS.md.
--no-setupOmit SETUP.MD and its terminal handoff.

The default scaffold contains:

index.md
log.md
SPEC.md
AGENTS.md
SETUP.MD

With both omission flags, the scaffold contains only index.md, log.md, and SPEC.md. The command creates a missing destination. It rejects an existing non-empty directory.

OKF does not require bundle metadata. --bundle-entry records only the mapping. Create the target page separately.

Powered by OpenKnowledge.sh