@geminilight/mindos 0.1.0

package/templates/empty/INSTRUCTION.md

@@ -0,0 +1,177 @@
+# MindOS Instruction Set
+
+This file defines the base operating rules for collaboration between humans and agents inside the knowledge base.
+
+> This file contains stable rules. Variable content (structure details, preferences, SOP specifics) should live in dedicated files.
+>
+> Terms: `MUST` = mandatory, `SHOULD` = strongly recommended.
+
+---
+
+## 1. Bootstrap Order
+
+When entering a knowledge base, load context in this order:
+
+1. Read root `INSTRUCTION.md` (this file)
+2. Read root `README.md` (index and navigation)
+3. Read `CONFIG.json` and `CONFIG.md` together (config values + semantic explanation)
+4. Route to the target directory
+5. If target directory has `INSTRUCTION.md`, read it first
+6. Then read target `README.md` and target files
+7. Execute
+
+Step 1 is **MUST**. Steps 2-6 are **SHOULD**, and must not be skipped for write/delete/rename operations.
+
+---
+
+## 2. File Roles and Priority
+
+### 2.1 File Roles
+
+| File | Role |
+|------|------|
+| Root `INSTRUCTION.md` | Global immutable rules and precedence |
+| Subdirectory `INSTRUCTION.md` | Local execution rules for that directory |
+| `README.md` | Navigation and usage guidance |
+| Regular content files | Business content (SOPs, profiles, records) |
+
+### 2.2 Priority (Strict)
+
+`root INSTRUCTION.md` > `subdirectory INSTRUCTION.md` > `README.md` > `regular content files`
+
+- Resolve conflicts using this exact order.
+- `README.md` cannot override any `INSTRUCTION.md` rule.
+
+### 2.3 README.md Standard
+
+Each first-level directory (such as `👤 Profile/`, `🔗 Connections/`, `🔄 Workflows/`) should include a `README.md` with:
+
+1. **One-line purpose** (directory responsibility)
+2. **📁 Structure** (file tree + short notes)
+3. **💡 Usage** (what each file/subdirectory is for)
+
+Rules like update policy, execution boundaries, and precedence belong to `INSTRUCTION.md`, not to README standards.
+
+---
+
+## 3. How to Create Subdirectory INSTRUCTION.md
+
+Create it only when local rules are reusable and meaningful. Avoid creating them by default.
+
+### 3.1 Good Cases
+
+- Multiple files under one directory share execution constraints
+- The directory has its own schema or safety boundary
+- The directory is high-frequency and mistakes are costly
+
+### 3.2 Avoid Cases
+
+- Pure structural description (put in README)
+- One-off notes with no reuse
+- Highly unstable rules with no fixed boundary
+
+### 3.3 Standard Steps
+
+1. Create `INSTRUCTION.md` in the target directory
+2. Write only local rules; do not duplicate root rules
+3. Explicitly state: if conflict exists, root rules win
+4. Add one line in that directory README usage section: read local `INSTRUCTION.md` before execution
+
+### 3.4 Minimal Template
+
+```markdown
+# <Domain> Instruction Set
+
+## Goal
+- Local goal for this directory
+
+## Local Rules
+- Rule 1
+- Rule 2
+
+## Execution Order
+1. Root `INSTRUCTION.md`
+2. Local `INSTRUCTION.md`
+3. Local `README.md` and target files
+
+## Boundary
+- Root rules win on conflict
+```
+
+### 3.5 Recommendation for First-Level Directories (Project Root Children)
+
+- First-level directories are direct children of the project root, for example: `🔗 Connections/`, `🔄 Workflows/`, `👤 Profile/`, `📚 Resources/`.
+- It is recommended that these first-level directories provide a lightweight `INSTRUCTION.md` by default.
+- A lightweight version should include at least:
+  - Directory goal
+  - Local rules (2-5 items)
+  - Execution order (root rules -> local rules -> README/target files)
+  - Conflict fallback statement (root rules win)
+- If a first-level directory truly has no stable rules, you may skip it temporarily; once repeated constraints appear, add it immediately.
+
+---
+
+## 4. Filesystem Rules
+
+### 4.1 File Types
+
+- Documents: `.md`
+- Data: `.csv`
+- Config: `.json`
+
+### 4.2 Naming
+
+- Content files: optional `emoji + name`
+- Directories: follow `languagePreference.folderNamingLanguage`; zh templates default to Chinese naming, en templates default to English naming.
+- System files: `README.md`, `INSTRUCTION.md`, `TODO.md`, `CHANGELOG.md`, `CONFIG.json`, `CONFIG.md`
+
+### 4.3 Read-Before-Write
+
+- **MUST** read target file before writing
+- **SHOULD** verify CSV header before append
+
+---
+
+## 5. Sync and Change Rules
+
+### 5.1 Must Sync
+
+- Add/delete/rename first-level directory: update root `README.md`
+- Delete/rename files: update all references
+
+### 5.2 Should Sync
+
+- Add new files: update that directory README tree
+- CSV row append: no README sync required
+
+---
+
+## 6. Safety Boundaries
+
+- **MUST** not delete files unless user explicitly requests
+- **MUST** not store secrets (keys, tokens, passwords)
+- Confirm before bulk delete or structural reorganization
+
+---
+
+## 7. Tracking
+
+- `TODO.md`: pending tasks
+- `CHANGELOG.md`: completed items (reverse chronological)
+
+---
+
+## 8. Example Data Isolation (Naming Convention)
+
+- Example files/directories must use `_example` or `_examples` in naming.
+- Do not use `.example` or `.examples` to avoid hidden-file semantic confusion.
+- Any content containing `_example` or `_examples` is example-only, not user production data.
+- Example content may demonstrate structure/style, but must not be treated as real facts for execution.
+
+---
+
+## 9. CONFIG Read Protocol
+
+- `CONFIG.json` and `CONFIG.md` must be read together.
+- They are complementary and have no priority relationship.
+- `CONFIG.json` provides structured config values; `CONFIG.md` provides semantic explanation and intent.

package/templates/empty/README.md

@@ -0,0 +1,27 @@
+# My Mind
+
+Root entry of your personal knowledge system. Agents should read this index before execution.
+
+## 📁 Structure
+
+```bash
+my-mind/
+├── INSTRUCTION.md
+├── README.md
+├── CONFIG.json
+├── CONFIG.md
+├── TODO.md
+├── CHANGELOG.md
+├── 👤 Profile/
+├── 📝 Notes/
+├── 🔗 Connections/
+├── 🔄 Workflows/
+├── 📚 Resources/
+└── 🚀 Projects/
+```
+
+## 💡 Usage
+
+- Bootstrap read order: `INSTRUCTION.md` -> `README.md` -> `CONFIG.json` + `CONFIG.md`
+- Capture first in `📝 Notes/`, then move stable content to domain folders
+- Directories that need regular updates: `👤 Profile/`, `🔗 Connections/`, `🚀 Projects/`

package/templates/en/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 📋 CHANGELOG
+
+> Log completed items in reverse chronological order.
+
+## YYYY-MM-DD
+
+### Category
+
+- Description of completed item

package/templates/en/CONFIG.json

@@ -0,0 +1,197 @@
+{
+  "schemaVersion": "1.1",
+  "locale": "en",
+  "languagePreference": {
+    "preferredLanguage": "en",
+    "supportedLanguages": [
+      {
+        "value": "zh",
+        "label": "Chinese"
+      },
+      {
+        "value": "en",
+        "label": "English"
+      }
+    ],
+    "folderNamingLanguage": "en",
+    "contentWritingLanguage": "en",
+    "enforceLocalizedNaming": true
+  },
+  "filename": {
+    "emojiPrefixDefault": true,
+    "allowEmojiPrefix": true,
+    "exampleSuffixSingle": "_example",
+    "exampleSuffixCollection": "_examples"
+  },
+  "structure": {
+    "requireFirstLevelReadme": true,
+    "recommendFirstLevelInstruction": true
+  },
+  "document": {
+    "title": {
+      "emojiEnabled": true,
+      "defaultHeadingLevel": 2
+    }
+  },
+  "protocol": {
+    "readMode": "config_and_doc",
+    "priorityBetweenConfigAndDoc": "none",
+    "notes": [
+      "CONFIG.json and CONFIG.md must be read together",
+      "They are complementary and have no priority relationship"
+    ]
+  },
+  "uiSchema": {
+    "version": "1.0",
+    "sections": [
+      {
+        "id": "filename",
+        "title": "Filename",
+        "description": "Controls naming behavior for generated files",
+        "fields": [
+          "filename.emojiPrefixDefault",
+          "filename.allowEmojiPrefix",
+          "filename.exampleSuffixSingle",
+          "filename.exampleSuffixCollection"
+        ]
+      },
+      {
+        "id": "structure",
+        "title": "Structure",
+        "description": "Controls directory constraints and locale sync",
+        "fields": [
+          "structure.requireFirstLevelReadme",
+          "structure.recommendFirstLevelInstruction"
+        ]
+      },
+      {
+        "id": "document_title",
+        "title": "Title Generation",
+        "description": "Controls default generation behavior for document titles",
+        "fields": [
+          "document.title.emojiEnabled",
+          "document.title.defaultHeadingLevel"
+        ]
+      },
+      {
+        "id": "language_preference",
+        "title": "Language Preference",
+        "description": "Controls language used for folder naming and generated content writing",
+        "fields": [
+          "languagePreference.preferredLanguage",
+          "languagePreference.folderNamingLanguage",
+          "languagePreference.contentWritingLanguage",
+          "languagePreference.enforceLocalizedNaming"
+        ]
+      }
+    ]
+  },
+  "keySpecs": {
+    "filename.emojiPrefixDefault": {
+      "type": "boolean",
+      "control": "switch",
+      "label": "Default Emoji Prefix",
+      "description": "Whether newly generated filenames should default to emoji prefix"
+    },
+    "filename.allowEmojiPrefix": {
+      "type": "boolean",
+      "control": "switch",
+      "label": "Allow Emoji Prefix",
+      "description": "Whether filenames are allowed to include emoji prefix"
+    },
+    "filename.exampleSuffixSingle": {
+      "type": "string",
+      "control": "text",
+      "label": "Single Example Suffix",
+      "description": "Filename suffix for single example files, default _example"
+    },
+    "filename.exampleSuffixCollection": {
+      "type": "string",
+      "control": "text",
+      "label": "Example Collection Suffix",
+      "description": "Directory suffix for example collections, default _examples"
+    },
+    "structure.requireFirstLevelReadme": {
+      "type": "boolean",
+      "control": "switch",
+      "label": "Require First-Level README",
+      "description": "Each first-level directory under root must include README.md"
+    },
+    "structure.recommendFirstLevelInstruction": {
+      "type": "boolean",
+      "control": "switch",
+      "label": "Recommend First-Level INSTRUCTION",
+      "description": "Whether first-level directories are recommended to include local INSTRUCTION.md"
+    },
+    "document.title.emojiEnabled": {
+      "type": "boolean",
+      "control": "switch",
+      "label": "Emoji in Title",
+      "description": "Whether generated titles allow emoji by default"
+    },
+    "document.title.defaultHeadingLevel": {
+      "type": "integer",
+      "control": "number",
+      "label": "Default Heading Level",
+      "description": "Default Markdown heading level for generated titles",
+      "constraints": {
+        "min": 1,
+        "max": 6
+      }
+    },
+    "languagePreference.preferredLanguage": {
+      "type": "enum",
+      "control": "select",
+      "options": [
+        {
+          "value": "zh",
+          "label": "Chinese"
+        },
+        {
+          "value": "en",
+          "label": "English"
+        }
+      ],
+      "label": "Preferred Language",
+      "description": "Global language preference for default generation strategy"
+    },
+    "languagePreference.folderNamingLanguage": {
+      "type": "enum",
+      "control": "select",
+      "options": [
+        {
+          "value": "zh",
+          "label": "Chinese"
+        },
+        {
+          "value": "en",
+          "label": "English"
+        }
+      ],
+      "label": "Folder/Filename Language",
+      "description": "Controls language for generated folder and filename naming"
+    },
+    "languagePreference.contentWritingLanguage": {
+      "type": "enum",
+      "control": "select",
+      "options": [
+        {
+          "value": "zh",
+          "label": "Chinese"
+        },
+        {
+          "value": "en",
+          "label": "English"
+        }
+      ],
+      "label": "Content Writing Language",
+      "description": "Controls language used for generated document content"
+    },
+    "languagePreference.enforceLocalizedNaming": {
+      "type": "boolean",
+      "control": "switch",
+      "label": "Enforce Localized Naming",
+      "description": "When enabled, zh template requires Chinese names and en template requires English names"
+    }
+  }
+}

package/templates/en/CONFIG.md

@@ -0,0 +1,73 @@
+# CONFIG Guide
+
+This file explains template config in human-readable form.
+
+## Scope
+
+- Locale scope: `templates/en/`.
+- Related machine-readable file: `templates/en/CONFIG.json`.
+
+## Read Rule
+
+- `CONFIG.json` and `CONFIG.md` must be read together.
+- They are complementary and have no priority relationship.
+- JSON provides structured values; MD provides explanatory intent.
+
+## Key Settings
+
+### `languagePreference`
+
+- `preferredLanguage`: global language preference
+- `supportedLanguages`: selectable language options
+- `folderNamingLanguage`: language used for folder/filename generation
+- `contentWritingLanguage`: language used for generated writing content
+- `enforceLocalizedNaming`: whether localized naming is enforced (en template defaults to English naming)
+
+### `filename`
+
+- `emojiPrefixDefault`: whether new filenames default to emoji prefix
+- `allowEmojiPrefix`: whether emoji prefix is allowed in filenames
+- `exampleSuffixSingle`: suffix for single example files (default `_example`)
+- `exampleSuffixCollection`: suffix for example collection folders (default `_examples`)
+
+### `structure`
+
+- `requireFirstLevelReadme`: whether first-level directories must include `README.md`
+- `recommendFirstLevelInstruction`: whether first-level directories are recommended to include `INSTRUCTION.md`
+
+### `document.title`
+
+- `emojiEnabled`: whether generated titles allow emoji by default
+- `defaultHeadingLevel`: default heading level for generated titles (currently `2`)
+
+### `protocol`
+
+- `readMode`: config read mode
+- `priorityBetweenConfigAndDoc`: relationship between config values and docs (`none` means no priority)
+- `notes`: protocol notes
+
+## Directory Naming and Level Rules (Semantic Layer in CONFIG.md)
+
+These rules are directory naming semantics, documented in `CONFIG.md`:
+
+- First-level directories (direct children of project root) default to `emoji + name`.
+- Second-level and deeper directories default to no emoji.
+- Directory naming language is controlled by `languagePreference.folderNamingLanguage`.
+- Whether content filenames use emoji prefix is controlled by `filename.*`.
+
+Current template convention (en):
+
+- First-level examples: `👤 Profile/`, `📝 Notes/`, `🔗 Connections/`, `🔄 Workflows/`, `📚 Resources/`, `🚀 Projects/`
+- Second-level examples: `Family/`, `Friends/`, `Classmates/`, `Colleagues/` (no emoji)
+
+When naming policy changes:
+
+1. Update semantic rules in `CONFIG.md` first.
+2. Then sync `README.md`, `INSTRUCTION.md`, and actual directory structure.
+
+## Change Rules
+
+1. Update `templates/en/CONFIG.json` and `templates/zh/CONFIG.json` together when keys change.
+2. Keep semantic parity across both locales.
+3. Update both locale `CONFIG.md` files when keys are added/removed/renamed.
+4. Do not document defaults here that conflict with JSON values.

package/templates/en/INSTRUCTION.md

@@ -0,0 +1,177 @@
+# MindOS Instruction Set
+
+This file defines the base operating rules for collaboration between humans and agents inside the knowledge base.
+
+> This file contains stable rules. Variable content (structure details, preferences, SOP specifics) should live in dedicated files.
+>
+> Terms: `MUST` = mandatory, `SHOULD` = strongly recommended.
+
+---
+
+## 1. Bootstrap Order
+
+When entering a knowledge base, load context in this order:
+
+1. Read root `INSTRUCTION.md` (this file)
+2. Read root `README.md` (index and navigation)
+3. Read `CONFIG.json` and `CONFIG.md` together (config values + semantic explanation)
+4. Route to the target directory
+5. If target directory has `INSTRUCTION.md`, read it first
+6. Then read target `README.md` and target files
+7. Execute
+
+Step 1 is **MUST**. Steps 2-6 are **SHOULD**, and must not be skipped for write/delete/rename operations.
+
+---
+
+## 2. File Roles and Priority
+
+### 2.1 File Roles
+
+| File | Role |
+|------|------|
+| Root `INSTRUCTION.md` | Global immutable rules and precedence |
+| Subdirectory `INSTRUCTION.md` | Local execution rules for that directory |
+| `README.md` | Navigation and usage guidance |
+| Regular content files | Business content (SOPs, profiles, records) |
+
+### 2.2 Priority (Strict)
+
+`root INSTRUCTION.md` > `subdirectory INSTRUCTION.md` > `README.md` > `regular content files`
+
+- Resolve conflicts using this exact order.
+- `README.md` cannot override any `INSTRUCTION.md` rule.
+
+### 2.3 README.md Standard
+
+Each first-level directory (such as `👤 Profile/`, `🔗 Connections/`, `🔄 Workflows/`) should include a `README.md` with:
+
+1. **One-line purpose** (directory responsibility)
+2. **📁 Structure** (file tree + short notes)
+3. **💡 Usage** (what each file/subdirectory is for)
+
+Rules like update policy, execution boundaries, and precedence belong to `INSTRUCTION.md`, not to README standards.
+
+---
+
+## 3. How to Create Subdirectory INSTRUCTION.md
+
+Create it only when local rules are reusable and meaningful. Avoid creating them by default.
+
+### 3.1 Good Cases
+
+- Multiple files under one directory share execution constraints
+- The directory has its own schema or safety boundary
+- The directory is high-frequency and mistakes are costly
+
+### 3.2 Avoid Cases
+
+- Pure structural description (put in README)
+- One-off notes with no reuse
+- Highly unstable rules with no fixed boundary
+
+### 3.3 Standard Steps
+
+1. Create `INSTRUCTION.md` in the target directory
+2. Write only local rules; do not duplicate root rules
+3. Explicitly state: if conflict exists, root rules win
+4. Add one line in that directory README usage section: read local `INSTRUCTION.md` before execution
+
+### 3.4 Minimal Template
+
+```markdown
+# <Domain> Instruction Set
+
+## Goal
+- Local goal for this directory
+
+## Local Rules
+- Rule 1
+- Rule 2
+
+## Execution Order
+1. Root `INSTRUCTION.md`
+2. Local `INSTRUCTION.md`
+3. Local `README.md` and target files
+
+## Boundary
+- Root rules win on conflict
+```
+
+### 3.5 Recommendation for First-Level Directories (Project Root Children)
+
+- First-level directories are direct children of the project root, for example: `🔗 Connections/`, `🔄 Workflows/`, `👤 Profile/`, `📚 Resources/`.
+- It is recommended that these first-level directories provide a lightweight `INSTRUCTION.md` by default.
+- A lightweight version should include at least:
+  - Directory goal
+  - Local rules (2-5 items)
+  - Execution order (root rules -> local rules -> README/target files)
+  - Conflict fallback statement (root rules win)
+- If a first-level directory truly has no stable rules, you may skip it temporarily; once repeated constraints appear, add it immediately.
+
+---
+
+## 4. Filesystem Rules
+
+### 4.1 File Types
+
+- Documents: `.md`
+- Data: `.csv`
+- Config: `.json`
+
+### 4.2 Naming
+
+- Content files: optional `emoji + name`
+- Directories: follow `languagePreference.folderNamingLanguage`; zh templates default to Chinese naming, en templates default to English naming.
+- System files: `README.md`, `INSTRUCTION.md`, `TODO.md`, `CHANGELOG.md`, `CONFIG.json`, `CONFIG.md`
+
+### 4.3 Read-Before-Write
+
+- **MUST** read target file before writing
+- **SHOULD** verify CSV header before append
+
+---
+
+## 5. Sync and Change Rules
+
+### 5.1 Must Sync
+
+- Add/delete/rename first-level directory: update root `README.md`
+- Delete/rename files: update all references
+
+### 5.2 Should Sync
+
+- Add new files: update that directory README tree
+- CSV row append: no README sync required
+
+---
+
+## 6. Safety Boundaries
+
+- **MUST** not delete files unless user explicitly requests
+- **MUST** not store secrets (keys, tokens, passwords)
+- Confirm before bulk delete or structural reorganization
+
+---
+
+## 7. Tracking
+
+- `TODO.md`: pending tasks
+- `CHANGELOG.md`: completed items (reverse chronological)
+
+---
+
+## 8. Example Data Isolation (Naming Convention)
+
+- Example files/directories must use `_example` or `_examples` in naming.
+- Do not use `.example` or `.examples` to avoid hidden-file semantic confusion.
+- Any content containing `_example` or `_examples` is example-only, not user production data.
+- Example content may demonstrate structure/style, but must not be treated as real facts for execution.
+
+---
+
+## 9. CONFIG Read Protocol
+
+- `CONFIG.json` and `CONFIG.md` must be read together.
+- They are complementary and have no priority relationship.
+- `CONFIG.json` provides structured config values; `CONFIG.md` provides semantic explanation and intent.

package/templates/en/README.md

@@ -0,0 +1,27 @@
+# My Mind
+
+Root entry of your personal knowledge system. Agents should read this index before execution.
+
+## 📁 Structure
+
+```bash
+my-mind/
+├── INSTRUCTION.md
+├── README.md
+├── CONFIG.json
+├── CONFIG.md
+├── TODO.md
+├── CHANGELOG.md
+├── 👤 Profile/
+├── 📝 Notes/
+├── 🔗 Connections/
+├── 🔄 Workflows/
+├── 📚 Resources/
+└── 🚀 Projects/
+```
+
+## 💡 Usage
+
+- Bootstrap read order: `INSTRUCTION.md` -> `README.md` -> `CONFIG.json` + `CONFIG.md`
+- Capture first in `📝 Notes/`, then move stable content to domain folders
+- Directories that need regular updates: `👤 Profile/`, `🔗 Connections/`, `🚀 Projects/`

package/templates/en/TODO.md

@@ -0,0 +1,13 @@
+# TODO
+
+## TODAY
+
+- [ ]
+
+## This Week
+
+- [ ]
+
+## Backlog
+
+- [ ]