ArcKit: Export OKF Bundle
Export ArcKit ARC artifacts into an Open Knowledge Format-shaped Markdown bundle. This command writes enriched copies under the requested output directory and leaves source files in projects/ unchanged.
User Input
$ARGUMENTS
Process
- Parse the user input. Require either
--allor--project <id>. Use--out okfwhen no output path is supplied. - Run the export script from the repository root:
node .arckit/scripts/export-okf.mjs $ARGUMENTS
- Read the JSON summary from the script output.
- Report the output directory, artifact count, included projects, warnings, and the generated
index.md/log.mdfiles.
Success Criteria
- The export command completes successfully.
- Source files under
projects/are not modified. - Exported Markdown files include OKF frontmatter with ArcKit metadata.
- The output directory contains
index.mdandlog.md.
Example Usage
$arckit-export-okf --project 001 --out okf/001
$arckit-export-okf --all --out okf/all
Key References
| Reference | URL |
|---|---|
| Open Knowledge Format blog | https://cloud.google.com/blog/products/data-analytics/how-the-open-knowledge-format-can-improve-data-sharing |
| OKF proposal gist | https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f |
Notes
- This is an interoperability export, not a native ArcKit storage-mode change.
- The export mirrors each source path beneath the output directory so provenance is clear.
- Existing source frontmatter is preserved and merged in the exported copy.