Knowledge OS Starter Kit

Open-source, Markdown-driven installer for creating a portable Knowledge OS for business, projects, personal work, research, learning, and AI-assisted execution.

What It Generates

• Numbered Obsidian-compatible domain structure.
• Canonical AGENTS.md router with thin Claude and Codex adapters.
• Durable memory.md and current-state handoff.md.
• Context, metadata, privacy, token, archive, and automation policies.
• Optional examples, Git initialization, and migration-safe conflict files.
• Installation state, privacy scan, and validation report.

Supported Execution

• Codex CLI
• Claude Code
• PowerShell 7+
• Bash 4+ with Python 3
• Obsidian and VS Code
• Any capable agent that can execute KOS-INSTALLER.md

Quick Start

Windows:

.\initialize.ps1 -Agent codex

macOS or Linux:

./initialize.sh --agent codex

Direct answer-file installation:

.\install.ps1 -Answers .\installer\answers.example.json -DryRun
.\install.ps1 -Answers .\installer\answers.example.json

Privacy Model

The reference system is used only to derive reusable architecture and behavior. Its private notes, identities, organizations, projects, histories, inventories, credentials, and operational state are not included. Generated sensitive material defaults to internal or restricted handling. External integrations start as Not configured.

Generated Knowledge OS repositories are private by default. They may contain identity, business, project, daily, personal, attachment, and installation metadata. Do not connect a generated system to a public remote without a separate content review.

Project Structure

• KOS-INSTALLER.md: canonical agent-executable installer contract.
• QUESTIONNAIRE.md: interactive and answer-file questions.
• installer/: schema, examples, state template, and installation engine.
• templates/: neutral source templates.
• scripts/: validation, privacy, and manifest utilities.
• reports/: design analysis and build evidence.
• test-output/: disposable synthetic installations.

Status

Public-release candidate. Complete PUBLICATION.md before the initial public push.

License

This project is licensed under the Apache License 2.0.

See the LICENSE file for the full license text and the NOTICE file for attribution information.