@tmddev/tmd 0.1.0

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 [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,424 @@
+<p align="center">
+  <strong>TMD - Task Markdown Driven</strong>
+</p>
+
+<p align="center">
+  <strong>Ten seconds to Ten minutes Task Markdown Driven Development!</strong>
+</p>
+
+<p align="center">
+  <a href="https://tmdd.dev"><img alt="Website" src="https://img.shields.io/badge/Website-tmdd.dev-blue?style=flat-square" /></a>
+  <a href="https://github.com/sdd330/tmd/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/sdd330/tmd/actions/workflows/ci.yml/badge.svg" /></a>
+  <a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" /></a>
+  <a href="https://conventionalcommits.org"><img alt="Conventional Commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square" /></a>
+</p>
+
+# TMD - Task Markdown Driven
+
+**Ten seconds to Ten minutes Task Markdown Driven Development!**
+
+A lightweight PDCA cycle management framework integrated with OpenSpec for specification-driven development.
+
+## 🌐 Website
+
+This project is available at: **[https://tmdd.dev](https://tmdd.dev)**
+
+## Overview
+
+**Ten seconds to Ten minutes Task Markdown Driven Development!**
+
+TMD (Task Markdown Driven) combines OpenSpec's specification-driven development with the PDCA (Plan-Do-Check-Act) continuous improvement methodology. It provides a structured, traceable development management tool that ensures transparency and traceability through documentation-driven processes.
+
+At the core of TMD is the principle that tasks should be **pee-break (10 seconds to 10 minutes)** sized - small, atomic, and completable in a single focused session.
+
+## Features
+
+- **PDCA Cycle Management**: Four-phase commands for Plan, Do, Check, and Act
+- **Ten sec to Ten min Task!**: Tasks are designed to be pee-break (10 seconds to 10 minutes) sized for quick completion
+- **OpenSpec Integration**: Automatic creation and linking of OpenSpec change proposals
+- **Skills System**: Reusable capabilities for AI agents with cross-agent invocation support
+- **English Language Standard**: All documents and specifications use English
+- **Markdown-Based**: All documentation stored in Markdown format
+- **CLI Interface**: Simple command-line interface with aliases
+
+## Installation
+
+### Prerequisites
+- **Node.js >= 20.19.0** - Check your version with `node --version`
+
+### Install the CLI globally
+
+**Option A: Using npm**
+```bash
+npm install -g @tmddev/tmd@latest
+```
+
+Verify installation:
+```bash
+tmd --version
+```
+
+**Option B: Using pnpm**
+```bash
+pnpm install -g @tmddev/tmd@latest
+```
+
+**Option C: Use locally**
+```bash
+git clone https://github.com/sdd330/tmd.git
+cd tmd
+pnpm install
+pnpm run build
+pnpm link --global  # Optional: link for local development
+```
+
+## Quick Start
+
+### 1. Create a Plan
+
+```bash
+tmd plan "Generate README in different languages"
+# or use alias
+tmdp "Generate README in different languages"
+```
+
+This creates:
+- Task directory structure
+- Plan document template
+- Resources document
+
+**Important: Task Size Guidelines - Ten sec to Ten min Task!**
+
+Tasks in the plan should be atomic and completable in **pee-break (10 seconds to 10 minutes)** sized tasks. This ensures:
+- Tasks are actionable and completable by AI agents or humans
+- Progress tracking is meaningful (tasks are either done or not done)
+- No task requires complex multi-step coordination
+- Agent Skills can be designed to complete individual tasks
+
+**Good atomic tasks:**
+- "Add import statement"
+- "Update function signature"
+- "Create test file"
+- "Fix typo in documentation"
+
+**Tasks to break down:**
+- "Implement authentication and authorization" → Break into: "Add auth middleware", "Create login endpoint", "Add password validation"
+- "Create API and update frontend" → Break into: "Create API endpoint", "Update frontend component", "Add API integration"
+
+### 2. Execute (Do Phase)
+
+```bash
+tmd do <task-id>
+# or use alias
+tmdd <task-id>
+```
+
+This creates:
+- Execution document
+- Data collection document
+
+### 3. Check Results
+
+```bash
+tmd check <task-id>
+# or use alias
+tmdc <task-id>
+```
+
+This creates:
+- Evaluation document
+- Deviation analysis document
+
+### 4. Act on Results
+
+```bash
+tmd act <task-id>
+# or use alias
+tmda <task-id>
+```
+
+This creates:
+- Improvement actions document
+- Standardization document (if `--standardize` flag is used)
+
+## Task Size Principle
+
+**Ten seconds to Ten minutes Task Markdown Driven Development!**
+
+Tasks should be **pee-break (10 seconds to 10 minutes)** sized.
+
+This principle ensures tasks are:
+- **Atomic**: Cannot be meaningfully broken down further
+- **Actionable**: Clear single action that can be completed
+- **Trackable**: Either done or not done (no partial states)
+- **Agent-friendly**: Suitable for AI agent autonomous execution
+- **Skill-compatible**: Can be completed by a single Agent Skill
+
+### Guidelines
+
+- ✅ **Good**: "Add import statement", "Update function signature", "Create test file"
+- ❌ **Too large**: "Implement authentication and authorization", "Create API and update frontend"
+- 💡 **Break down large tasks** into smaller atomic tasks before planning
+
+## Commands
+
+### PDCA Commands
+
+- `tmd plan <description>` / `tmdp` - Create a new plan
+  - `--openspec` - Create or link OpenSpec change proposal
+  - `--skill` - Create skill definition
+  - `--use-skill <skill-name>` - Use existing skill
+  - `--validate-tasks` - Validate task size: pee-break (10 seconds to 10 minutes)
+
+- `tmd do <task-id>` / `tmdd` - Execute actions
+  - `--data <key=value>` - Record data
+  - `--skill <skill-name>` - Execute skill
+
+- `tmd check <task-id>` / `tmdc` - Evaluate results
+  - `--compare` - Automatic comparison
+  - `--validate-skill` - Validate skill execution
+
+- `tmd act <task-id>` / `tmda` - Take improvement actions
+  - `--standardize` - Generate standardization document
+  - `--complete` - Mark task as completed
+
+### Task Management
+
+- `tmd list` - List all tasks
+  - `--status <status>` - Filter by status
+  - `--phase <phase>` - Filter by phase
+
+- `tmd show <task-id>` - Show task details
+
+### Skills Management
+
+- `tmd skills list` - List all available skills
+- `tmd skills search <query>` - Search skills
+- `tmd skills show <skill-name>` - Show skill details
+- `tmd skills invoke <skill-name> --input <params>` - Invoke a skill
+
+## Skills System
+
+Skills are reusable capabilities for AI agents that can be defined, shared, and executed within PDCA cycles.
+
+### Creating a Skill
+
+```bash
+tmd plan "As a developer, I want to generate README files in multiple languages, so as to make the project accessible to international contributors" --skill
+```
+
+This creates a skill with:
+- User story format
+- Executable steps definition
+- Configuration
+- Metadata for AI agent discovery
+
+### Example: README Generation Skill
+
+```yaml
+# tmd/skills/generate-readme-multilang/metadata.yaml
+name: generate-readme-multilang
+version: 1.0.0
+description: Generate README files in multiple languages
+interface:
+  input:
+    - name: template_path
+      type: string
+      required: true
+      description: Path to README.md template
+    - name: target_languages
+      type: array
+      required: true
+      description: List of target languages (e.g., ["zh", "es", "fr"])
+  output:
+    generated_files: array of file paths
+    validation_status: enum (passed/failed)
+    language_index_updated: boolean
+```
+
+### Cross-Agent Invocation
+
+Skills can be invoked by any AI agent:
+
+```bash
+tmd skill invoke generate-readme-multilang --input "template_path=README.md target_languages=[zh,es,fr]"
+```
+
+## OpenSpec Integration
+
+TMD automatically integrates with OpenSpec projects:
+
+```bash
+tmd plan "Description" --openspec
+```
+
+This:
+- Detects OpenSpec project structure
+- Creates OpenSpec change proposal
+- Links TMD task to OpenSpec change
+- Maintains bidirectional traceability
+
+## Directory Structure
+
+```
+tmd/
+├── plan/
+│   └── [task-id]/
+│       ├── plan.md
+│       └── resources.md
+├── do/
+│   └── [task-id]/
+│       ├── execution.md
+│       └── data.md
+├── check/
+│   └── [task-id]/
+│       ├── evaluation.md
+│       └── deviation.md
+├── act/
+│   └── [task-id]/
+│       ├── improvement.md
+│       └── standardization.md
+└── skills/
+    └── [skill-name]/
+        ├── skill.md
+        ├── steps.yaml
+        ├── config.yaml
+        └── metadata.yaml
+```
+
+## Examples
+
+### Example 1: Generate README in Different Languages
+
+```bash
+# Plan (with atomic tasks in plan.md)
+tmd plan "Generate README in different languages"
+# Tasks in plan.md should be broken down, e.g.:
+# - [ ] Read README.md template file
+# - [ ] Extract translatable sections
+# - [ ] Translate content to Chinese
+# - [ ] Translate content to Spanish
+# - [ ] Generate README.zh.md
+# - [ ] Generate README.es.md
+# - [ ] Validate markdown syntax
+# - [ ] Update language index in main README
+
+# Do
+tmd do 20240115-generate-readme-different-languages
+
+# Check
+tmd check 20240115-generate-readme-different-languages --compare
+
+# Act
+tmd act 20240115-generate-readme-different-languages --standardize --complete
+```
+
+**Note**: The plan should break down the high-level goal into atomic pee-break (10 seconds to 10 minutes) sized tasks (**Ten sec to Ten min Task!**) in the Tasks section of plan.md.
+
+### Example 2: Using Skills
+
+```bash
+# Create a skill
+tmd plan "As a developer, I want to generate README files in multiple languages, so as to make the project accessible to international contributors" --skill
+
+# Use the skill in a new task
+tmd plan "Generate README for new project" --use-skill generate-readme-multilang
+
+# Execute the skill
+tmd do <task-id> --skill generate-readme-multilang
+```
+
+## Language Standard
+
+All documents and specifications use English. The system:
+- Generates all templates in English
+- Validates user input (warns if non-English detected)
+- Enforces English for OpenSpec specifications
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build
+pnpm run build
+
+# Development mode (watch)
+pnpm run dev
+
+# Test
+pnpm test
+```
+
+## How It Works
+
+TMD follows the PDCA (Plan-Do-Check-Act) cycle:
+
+```
+┌────────────────────┐
+│ Plan               │
+│ Define objectives  │
+│ Set goals & tasks  │
+└────────┬───────────┘
+         │
+         ▼
+┌────────────────────┐
+│ Do                 │
+│ Execute tasks      │
+│ Collect data       │
+└────────┬───────────┘
+         │
+         ▼
+┌────────────────────┐
+│ Check              │
+│ Evaluate results   │
+│ Analyze deviations │
+└────────┬───────────┘
+         │
+         ▼
+┌────────────────────┐
+│ Act                │
+│ Improve &          │
+│ Standardize        │
+└────────────────────┘
+```
+
+## Task Size Principle
+
+**Ten seconds to Ten minutes Task Markdown Driven Development!**
+
+Tasks should be **pee-break (10 seconds to 10 minutes)** sized. This ensures:
+- Tasks are atomic and completable
+- Progress tracking is meaningful
+- No complex multi-step coordination required
+- Agent-friendly for AI autonomous execution
+
+## Contributing
+
+Contributions are welcome! Please ensure all documentation follows the English language standard.
+
+### Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build
+pnpm run build
+
+# Test
+pnpm test
+
+# Development mode (watch)
+pnpm run dev
+
+# Lint
+pnpm lint
+```
+
+See [MAINTAINERS.md](MAINTAINERS.md) for maintainer information.
+
+## License
+
+MIT

package/bin/tmd.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../dist/cli.js';

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map