@our2ndbrain/cli 1.1.3

package/AGENTS.md

@@ -0,0 +1,193 @@
+# AGENTS.md
+
+> This is the project guide for AI assistants. When helping users operate this project, please follow these rules.
+
+## Installing 2ndBrain CLI
+
+```bash
+# Use npx to run directly (recommended)
+npx @our2ndbrain/cli@latest <command>
+
+# Or install globally
+npm install -g @our2ndbrain/cli
+2ndbrain <command>
+```
+
+## Project Overview
+
+**2ndBrain** is a personal knowledge management system based on PARA + C-O-R-D + Append-and-Review, using Obsidian as the frontend tool.
+
+## Directory Structure Conventions
+
+```
+2ndBrain/
+├── 00_Dashboard/          # Dashboards: task aggregation entry point
+├── 10_Inbox/              # Inbox: journals land here
+│   └── {MemberName}/      #   One subdirectory per member
+├── 20_Areas/              # Areas: long-term focus areas
+├── 30_Projects/           # Projects: things with clear goals
+├── 40_Resources/          # Resources: reference materials
+├── 90_Archives/           # Archives: completed or inactive items
+└── 99_System/             # System: templates, scripts and config
+    ├── Scripts/           #   Automation scripts
+    └── Templates/         #   Note templates
+```
+
+## Core Rules
+
+### 1. Task Format
+
+All tasks use Markdown checkbox format:
+
+```markdown
+- [ ] Task description #tag 📅 2026-01-15
+```
+
+### 2. Tag Conventions
+
+| Tag | Purpose |
+|-----|---------|
+| `#next` | Next task to do |
+| `#waiting` | Waiting on others |
+| `#someday` | Later task |
+| `#read` / `#watch` / `#listen` | Read/watch/listen lists |
+| `📅 YYYY-MM-DD` | Due date |
+
+### 3. Journal Heading Structure
+
+Use the following headings in journals to categorize content. Dashboards will auto-recognize them:
+
+- `## 💼 Works` - Work tasks
+- `## 💡 Thoughts` - Ideas and inspirations
+- `## 📚 Readings` - Reading list
+
+### 4. File Placement Rules
+
+- **All new content** → First put in journals under `10_Inbox/{member}/`
+- **Clear goals** → `30_Projects/`
+- **Long-term maintenance** → `20_Areas/`
+- **Reference materials** → `40_Resources/`
+- **No longer active** → `90_Archives/`
+
+## Common Operations
+
+### Creating a New Member
+
+Use CLI command:
+
+```bash
+npx @our2ndbrain/cli@latest member {MemberName}
+```
+
+This creates:
+- `10_Inbox/{MemberName}/01_Tasks.md` - Personal task dashboard
+- `10_Inbox/{MemberName}/09_Done.md` - Personal completion record
+- `.obsidian/daily-notes.json` - Configures journal to save to that member directory
+
+> 💡 Use `--no-config` option for team collaboration to avoid overwriting other members' config.
+
+## AI Assistant Notes
+
+1. **Don't modify Dataview queries in dashboard files**
+   - Global dashboards: `00_Dashboard/01_All_Tasks.md` and `09_All_Done.md`
+   - Personal dashboards: `10_Inbox/{member}/01_Tasks.md` and `09_Done.md`
+   - These are auto-generated dashboards. Only modify tasks in journals, dashboards will auto-update.
+
+2. **Use template when creating journals**
+   - Template located at `99_System/Templates/tpl_daily_note.md`
+   - Journal naming format: `YYYY-MM-DD.md`
+
+3. **After task completion**
+   - Change `- [ ]` to `- [x]`
+   - Tasks plugin will auto-add completion date `✅ YYYY-MM-DD`
+
+4. **Follow user's language preference**
+   - Adapt responses to user's language settings
+   - Match the language used in the conversation
+
+## Agent Collaboration Design
+
+AI assistants and humans **coexist collaboratively** in 2ndBrain. Agents can directly operate all directories (`20_Areas/`, `30_Projects/`, `40_Resources/`, etc.), only need a shared workspace to record work logs.
+
+### Shared Workspace
+
+All Agents share the `10_Inbox/Agents/` directory (note: plural), using a single-file Journal mode:
+
+```
+10_Inbox/Agents/
+└── Journal.md    # All Agents' work logs (append-and-review)
+```
+
+### Journal Format
+
+Uses **append-and-review** mode:
+- **Append**: New content appended to file end, separated by delimiters per entry
+- **Review**: Periodically review TODOs, check off when complete; valuable content can be output to other directories
+
+```markdown
+# Agent Journal
+
+---
+2026-01-14 15:30 | Cursor
+
+Executed xxx task...
+
+- [ ] Discovered issue #next
+
+---
+2026-01-14 16:45 | Claude Desktop
+
+Optimized yyy...
+
+## 💡 Improvement Suggestions
+
+- Suggest zzz
+```
+
+### Why This Design?
+
+| Feature | Reason |
+|---------|--------|
+| **Shared directory** | Agents aren't "people", don't need isolated personal spaces |
+| **Single file** | Read once for full context, highest efficiency |
+| **Append-and-Review** | Simple writing + periodic organization, follows C-O-R-D workflow |
+| **Timestamp + Agent name** | Know who did what when |
+
+### Review Workflow
+
+Journal content can be output to other directories during review:
+
+| Content Type | Output Target |
+|-------------|---------------|
+| Completed TODOs | Check off `[x]` stay in place |
+| Discovered issues/solutions | → `30_Projects/` related projects |
+| Reusable experience | → `40_Resources/` or `20_Areas/` |
+| Error post-mortem | Keep in Journal as history |
+
+### When to Write Journal
+
+- After executing complex tasks (migration, refactoring, batch modifications)
+- When discovering issues that need fixing
+- When having improvement suggestions
+- When encountering failures or anomalies
+
+### Work Principles
+
+1. **Prefer improving tools over bypassing them** - Manual operations are non-reproducible and error-prone. When encountering scenarios not supported by tools, improve the tool first then execute.
+2. **Pay attention to naming consistency** - Tool design should consider naming differences to avoid sync failures due to inconsistent naming.
+
+### Tasks in Journal
+
+Agents can write todo tasks in Journal, Dashboard dashboards will auto-recognize:
+
+```markdown
+- [ ] Discovered xxx needs fixing #next
+- [ ] Suggest adding yyy feature #someday 📅 2026-01-30
+```
+
+> 💡 **Note**: Tasks with `#someday` tag will appear in "Future Plans" section, regardless of whether they have a due date. This is the dedicated area for "later" tasks.
+
+## Reference Links
+
+- [README.md](README.md) - Complete project documentation
+- [Template repository](https://github.com/Our2ndBrain/2ndBrain-Template) - Open source template

package/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.3] - 2026-01-18
+
+### Added
+- reorder Next Actions before Future Plans in dashboard
+
+## [1.1.2] - 2026-01-18
+
+### Fixed
+- improve member dashboard update reliability and fix query syntax
+
+## [1.1.1] - 2026-01-18
+
+### Fixed
+- Fixed Tasks query syntax error in dashboard (changed `has due date due after today` to `due after today`)
+- Added .gitignore rules for temporary scripts in root directory
+
+### Changed
+- Synchronized README_en.md with README.md (added integration mode, Obsidian installation guide)
+- Added missing `-y, --yes` option to both README files
+
+## [1.1.0] - 2026-01-18
+
+### Added
+- add --reset-obsidian option to init command
+
+## [1.0.0] - 2026-01-18
+
+### Major Release - 2ndBrain CLI
+
+A personal knowledge management system CLI tool combining PARA, C-O-R-D, and Append-and-Review methodologies.
+
+### Added
+- **Changelog automation**: Automatic changelog generation from git commits via version.js
+- **Interactive diff preview**: Colored unified diff output in update command
+- **Smart file comparison**: Binary/large file detection using diff package
+- **Interactive prompts**: User confirmation system for updates
+- **Smart Obsidian merging**: Plugin manifest support for .obsidian directory
+- **Shell completion**: bash, zsh, fish support via `completion` command
+- **Member management**: Team member initialization with auto-updated dashboards
+- **AI assistant integration**: CLAUDE.md for Claude Code guidance
+- **Pre-configured plugins**: Recommended Obsidian plugins bundled
+
+### Changed
+- **Major refactor**: Enhanced update command with diff preview and review
+- **Framework files**: CHANGELOG.md and CLAUDE.md now sync with updates
+- **Documentation strategy**: README.md is Chinese-primary, English in README_en.md
+- **Plugin documentation**: Restructured as required/optional lists
+- **Package distribution**: Fixed npm packaging for all template files
+
+### Fixed
+- Changelog generation idempotency (no duplicate versions)
+- Empty version entries in changelog generation
+- Package.json bin and repository URL formats
+- Task query syntax for #someday tag handling
+- Bash completion EPIPE error handling
+
+### Removed
+- Bundled dataview plugin (now community plugin)
+- README_zh.md (consolidated into README.md)
+

package/CLAUDE.md

@@ -0,0 +1,153 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**2ndBrain** is a personal knowledge management system CLI tool published as `@our2ndbrain/cli`. It combines three methodologies:
+- **PARA**: Projects, Areas, Resources, Archives organizational structure
+- **C-O-R-D**: Collect → Organize → Review → Do workflow
+- **Append-and-Review**: Karpathy's note-taking approach (append first, organize during review)
+
+The CLI provides an Obsidian-based template with a Node.js CLI tool for setup and management. The tool is designed for both individual and team use, with Git integration for synchronization.
+
+## CLI Commands
+
+### Installation and Usage
+```bash
+# Use npx directly (recommended)
+npx @our2ndbrain/cli@latest <command>
+
+# Or install globally
+npm install -g @our2ndbrain/cli
+2ndbrain <command>
+```
+
+### Available Commands
+- `2ndbrain init [path]` - Initialize new project from template
+- `2ndbrain member <name> [path]` - Add new member directory
+- `2ndbrain update [path]` - Update framework files with diff preview
+- `2ndbrain remove [path]` - Remove framework files
+
+### Command Options
+**init**: `-f, --force` (overwrite), `-t, --template <path>` (custom template)
+**member**: `-f, --force` (overwrite), `--no-config` (skip Obsidian config)
+**update**: `-d, --dry-run` (preview), `-t, --template <path>` (custom template)
+**remove**: `-d, --dry-run` (preview), `-f, --force` (skip confirmation)
+
+### Publishing
+```bash
+npm version <major|minor|patch>  # Updates CHANGELOG.md via scripts/version.js
+# postversion hook runs: git push && git push --tags && npm publish
+```
+
+## Architecture
+
+### Entry Points
+- `bin/2ndbrain.js` - CLI entry point (Commander.js)
+- `src/index.js` - Main module that exports commands
+
+### Core Modules
+
+**src/lib/config.js** - Framework file definitions
+- `FRAMEWORK_FILES`: Files managed by init/update/remove (AGENTS.md, README.md, CHANGELOG.md, CLAUDE.md, dashboards, templates)
+- `FRAMEWORK_DIRS`: Directories created during init (00_Dashboard, 10_Inbox/Agents, 99_System)
+- `USER_DATA_DIRS`: Never touched by CLI (20_Areas, 30_Projects, 40_Resources, 90_Archives)
+- `COPY_DIRS`: Directories copied entirely (e.g., .obsidian with plugins)
+- `MARKER_FILE`: `AGENTS.md` - identifies a 2ndBrain project
+
+**src/lib/files.js** - File operations
+- `copyFiles()` - Basic file copying
+- `copyFilesSmart()` - Copy with comparison, dry-run support, change tracking
+- `removeFiles()` - File removal with tracking
+- `ensureDirs()` / `removeEmptyDirs()` - Directory management
+
+**src/lib/diff.js** - File comparison utilities
+- Uses `diff` npm package for line/word comparison
+- `compareFiles()` - Detects binary/large files, compares contents
+- `summarizeChanges()` - Returns added/removed line counts
+- `generateDiff()` / `formatDiffForTerminal()` - Unified diff with colors
+- Large file threshold: 100KB
+
+**src/lib/prompt.js** - Interactive prompts
+- `confirm()` - Yes/no prompts with defaults
+- `select()` - Multi-option selection
+- `confirmBatchUpdates()` - Bulk update confirmation
+- Special handling for binary/large files
+
+**src/commands/init.js** - Project initialization
+- Validates target directory (checks for existing 2ndBrain projects or non-empty dirs)
+- Creates framework and user data directories
+- Copies framework files and .obsidian config
+- Creates init-only files (e.g., 10_Inbox/Agents/Journal.md)
+
+**src/commands/member.js** - Member directory creation
+- Validates project is a 2ndBrain project
+- Creates `10_Inbox/{member}/` directory
+- Processes template files with `{{MEMBER_NAME}}` placeholder replacement
+- Updates `.obsidian/daily-notes.json` (unless `--no-config`)
+
+**src/commands/update.js** - Framework file updates
+- Compares template files with existing files
+- Shows diff with colored output for changes
+- Supports batch (all), review (individual), or skip modes
+- Also updates member dashboards using latest templates
+
+**src/commands/remove.js** - Framework file removal
+- Removes only framework files (never user data directories)
+- Cleans up empty directories
+
+### Key Design Patterns
+
+**Smart File Management**: Files are compared before copying to avoid unnecessary writes. Binary and large files are detected and handled specially.
+
+**Template System**: Member files use `{{MEMBER_NAME}}` placeholder that gets replaced during `member` command execution.
+
+**Framework vs User Data Separation**:
+- Framework files: Managed by CLI, can be updated/removed
+- User data directories: Created during init, never modified by CLI
+- This allows users to keep their content while updating framework
+
+**Dry Run Mode**: Both `update` and `remove` support `--dry-run` to preview changes before applying.
+
+## Directory Structure (PARA)
+
+```
+2ndBrain/
+├── 00_Dashboard/          # Task aggregation dashboards (Dataview/Tasks queries)
+├── 10_Inbox/              # Collection point (daily journals)
+│   ├── Agents/            # AI assistant shared workspace
+│   └── {MemberName}/      # Each member's personal directory
+├── 20_Areas/              # Long-term focus areas
+├── 30_Projects/           # Goal-oriented work
+├── 40_Resources/          # Reference materials
+├── 90_Archives/           # Completed/inactive content
+└── 99_System/             # Templates and scripts
+```
+
+## Task Format Convention
+
+Tasks use Markdown checkbox format with tags and dates:
+```markdown
+- [ ] Task description #tag 📅 YYYY-MM-DD
+```
+
+Tags: `#next` (do next), `#waiting` (waiting on others), `#someday` (later), `#read`/`#watch`/`#listen` (consume lists)
+
+## Dependencies
+
+- `commander` - CLI framework
+- `chalk` - Terminal colors
+- `fs-extra` - Enhanced file system operations
+- `diff` - File comparison/diff generation
+
+## Node.js Requirement
+
+Node.js >= 16.0.0 (specified in package.json `engines`)
+
+## Important Notes
+
+- The CLI is published as an npm package, so template files are bundled via `package.json` `files` field
+- `.obsidian/` directory is included in the package to provide pre-configured plugins
+- `AGENTS.md` serves as both documentation and the marker file for identifying 2ndBrain projects
+- Member directories are excluded from automatic updates (must be re-run manually if needed)

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Our2ndBrain
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.