Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c84f56574e | ||
|
|
4f2586691a | ||
|
|
1844bbb90f | ||
|
|
ab10960a4b |
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "planning-with-files",
|
||||
"version": "2.2.2",
|
||||
"version": "2.3.0",
|
||||
"description": "Manus-style persistent markdown files for planning, progress tracking, and knowledge storage. Includes hooks for automatic plan re-reading and completion verification. Use when starting complex tasks, multi-step projects, research tasks, or when you want structured output.",
|
||||
"author": {
|
||||
"name": "OthmanAdi",
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
# Installing planning-with-files for Codex
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Codex IDE installed
|
||||
- Git installed (optional, for cloning)
|
||||
|
||||
## Installation
|
||||
|
||||
### Option 1: Clone Repository (Recommended)
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.codex/skills
|
||||
cd ~/.codex/skills
|
||||
git clone https://github.com/OthmanAdi/planning-with-files.git
|
||||
```
|
||||
|
||||
### Option 2: Manual Copy
|
||||
|
||||
1. Download or clone this repository
|
||||
2. Copy the entire `planning-with-files/` directory to `~/.codex/skills/`
|
||||
3. Ensure the structure matches:
|
||||
```
|
||||
~/.codex/skills/planning-with-files/
|
||||
├── planning-with-files/
|
||||
│ ├── SKILL.md
|
||||
│ ├── templates/
|
||||
│ └── scripts/
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### If Using Superpowers
|
||||
|
||||
If you have [obra/superpowers](https://github.com/obra/superpowers) installed:
|
||||
|
||||
```bash
|
||||
~/.codex/superpowers/.codex/superpowers-codex use-skill planning-with-files
|
||||
```
|
||||
|
||||
Superpowers will find it in your personal skills directory.
|
||||
|
||||
### If NOT Using Superpowers
|
||||
|
||||
Manually read the skill file when starting complex tasks:
|
||||
|
||||
```bash
|
||||
cat ~/.codex/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
Or add to your `~/.codex/AGENTS.md`:
|
||||
|
||||
```markdown
|
||||
## Planning with Files
|
||||
|
||||
<IMPORTANT>
|
||||
For complex multi-step tasks (3+ steps, research, building projects):
|
||||
1. Read the planning-with-files skill: `cat ~/.codex/skills/planning-with-files/planning-with-files/SKILL.md`
|
||||
2. Create task_plan.md, findings.md, progress.md in your project directory
|
||||
3. Follow the 3-file pattern throughout the task
|
||||
</IMPORTANT>
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
Check that the skill exists:
|
||||
|
||||
```bash
|
||||
ls -la ~/.codex/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Skill not found
|
||||
|
||||
- Verify path: `~/.codex/skills/planning-with-files/planning-with-files/SKILL.md`
|
||||
- Check file exists and is readable
|
||||
- Ensure SKILL.md has proper YAML frontmatter
|
||||
|
||||
### Scripts not executing
|
||||
|
||||
**Windows users:**
|
||||
- Use PowerShell versions: `*.ps1`
|
||||
- Set execution policy: `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
|
||||
|
||||
**Unix/Mac users:**
|
||||
- Make scripts executable: `chmod +x ~/.codex/skills/planning-with-files/scripts/*.sh`
|
||||
|
||||
## Getting Help
|
||||
|
||||
- Issues: https://github.com/OthmanAdi/planning-with-files/issues
|
||||
- Documentation: https://github.com/OthmanAdi/planning-with-files
|
||||
@@ -0,0 +1,139 @@
|
||||
# Installing planning-with-files for OpenCode
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- OpenCode.ai installed
|
||||
- Git installed (optional, for cloning)
|
||||
|
||||
## Installation
|
||||
|
||||
### Option 1: Global Installation (All Projects)
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.config/opencode/skills
|
||||
cd ~/.config/opencode/skills
|
||||
git clone https://github.com/OthmanAdi/planning-with-files.git
|
||||
```
|
||||
|
||||
### Option 2: Project-Specific Installation
|
||||
|
||||
```bash
|
||||
# In your OpenCode project root
|
||||
mkdir -p .opencode/skills
|
||||
cd .opencode/skills
|
||||
git clone https://github.com/OthmanAdi/planning-with-files.git
|
||||
```
|
||||
|
||||
### Option 3: Manual Copy
|
||||
|
||||
**For global installation:**
|
||||
1. Download or clone this repository
|
||||
2. Copy to `~/.config/opencode/skills/planning-with-files/`
|
||||
|
||||
**For project installation:**
|
||||
1. Download or clone this repository
|
||||
2. Copy to `.opencode/skills/planning-with-files/` in your project
|
||||
|
||||
## File Structure
|
||||
|
||||
After installation:
|
||||
|
||||
```
|
||||
~/.config/opencode/skills/planning-with-files/ (or .opencode/skills/planning-with-files/)
|
||||
├── planning-with-files/
|
||||
│ ├── SKILL.md # Main skill file
|
||||
│ ├── templates/
|
||||
│ │ ├── task_plan.md
|
||||
│ │ ├── findings.md
|
||||
│ │ └── progress.md
|
||||
│ └── scripts/
|
||||
│ ├── check-complete.sh
|
||||
│ ├── check-complete.ps1
|
||||
│ ├── init-session.sh
|
||||
│ ├── init-session.ps1
|
||||
│ └── session-catchup.py
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### If Using Superpowers Plugin
|
||||
|
||||
If you have [obra/superpowers](https://github.com/obra/superpowers) installed as an OpenCode plugin:
|
||||
|
||||
```
|
||||
Use the use_skill tool with skill_name: "planning-with-files"
|
||||
```
|
||||
|
||||
OpenCode will find it automatically (personal skills override superpowers skills).
|
||||
|
||||
### If NOT Using Superpowers
|
||||
|
||||
You can still manually load the skill:
|
||||
|
||||
1. Navigate to `~/.config/opencode/skills/planning-with-files/planning-with-files/`
|
||||
2. Read SKILL.md
|
||||
3. Follow the instructions for creating task_plan.md, findings.md, progress.md
|
||||
|
||||
Or create a custom tool/command to load it.
|
||||
|
||||
## Skill Priority
|
||||
|
||||
If installed as:
|
||||
- **Project skill** (`.opencode/skills/planning-with-files/`) - Highest priority
|
||||
- **Personal skill** (`~/.config/opencode/skills/planning-with-files/`) - Medium priority
|
||||
- If superpowers has a planning-with-files skill - Lowest priority
|
||||
|
||||
Project skills override personal skills, which override superpowers skills.
|
||||
|
||||
## Verification
|
||||
|
||||
**Global installation:**
|
||||
```bash
|
||||
ls -la ~/.config/opencode/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
**Project installation:**
|
||||
```bash
|
||||
ls -la .opencode/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Skill not loading
|
||||
|
||||
1. Verify SKILL.md exists at the correct path
|
||||
2. Check YAML frontmatter is valid:
|
||||
```yaml
|
||||
---
|
||||
name: planning-with-files
|
||||
description: ...
|
||||
---
|
||||
```
|
||||
3. If using superpowers plugin, use `find_skills` tool to verify it's discovered
|
||||
|
||||
### Scripts not executing
|
||||
|
||||
**Windows:**
|
||||
- Use PowerShell versions: `*.ps1`
|
||||
- Set execution policy: `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
|
||||
|
||||
**Unix/Mac:**
|
||||
- Make executable: `chmod +x ~/.config/opencode/skills/planning-with-files/scripts/*.sh`
|
||||
|
||||
### oh-my-opencode Blocking
|
||||
|
||||
If using oh-my-opencode and the skill isn't recognized:
|
||||
|
||||
1. Check `~/.config/opencode/oh-my-opencode.json`
|
||||
2. Ensure planning-with-files is NOT in `disabled_skills` array:
|
||||
```json
|
||||
{
|
||||
"disabled_skills": []
|
||||
}
|
||||
```
|
||||
3. Restart OpenCode
|
||||
|
||||
## Getting Help
|
||||
|
||||
- Issues: https://github.com/OthmanAdi/planning-with-files/issues
|
||||
- Documentation: https://github.com/OthmanAdi/planning-with-files
|
||||
@@ -2,6 +2,55 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [2.3.0] - 2026-01-17
|
||||
|
||||
### Added
|
||||
|
||||
- **Codex IDE Support**
|
||||
- Created `.codex/INSTALL.md` with installation instructions
|
||||
- Skills install to `~/.codex/skills/planning-with-files/`
|
||||
- Works with obra/superpowers or standalone
|
||||
- Added `docs/codex.md` for user documentation
|
||||
- Based on analysis of obra/superpowers Codex implementation
|
||||
|
||||
- **OpenCode IDE Support** (Issue #27)
|
||||
- Created `.opencode/INSTALL.md` with installation instructions
|
||||
- Global installation: `~/.config/opencode/skills/planning-with-files/`
|
||||
- Project installation: `.opencode/skills/planning-with-files/`
|
||||
- Works with obra/superpowers plugin or standalone
|
||||
- oh-my-opencode compatibility documented
|
||||
- Added `docs/opencode.md` for user documentation
|
||||
- Based on analysis of obra/superpowers OpenCode plugin
|
||||
|
||||
### Changed
|
||||
|
||||
- Updated README.md with Supported IDEs table
|
||||
- Updated README.md file structure diagram
|
||||
- Updated docs/installation.md with Codex and OpenCode sections
|
||||
- Version bump to 2.3.0
|
||||
|
||||
### Documentation
|
||||
|
||||
- Added Codex and OpenCode to IDE support table in README
|
||||
- Created comprehensive installation guides for both IDEs
|
||||
- Documented skill priority system for OpenCode
|
||||
- Documented integration with superpowers ecosystem
|
||||
|
||||
### Research
|
||||
|
||||
This implementation is based on real analysis of:
|
||||
- [obra/superpowers](https://github.com/obra/superpowers) repository
|
||||
- Codex skill system and CLI architecture
|
||||
- OpenCode plugin system and skill resolution
|
||||
- Skill priority and override mechanisms
|
||||
|
||||
### Thanks
|
||||
|
||||
- @Realtyxxx for feedback on Issue #27 about OpenCode support
|
||||
- obra for the superpowers reference implementation
|
||||
|
||||
---
|
||||
|
||||
## [2.2.2] - 2026-01-17
|
||||
|
||||
### Fixed
|
||||
|
||||
@@ -16,7 +16,7 @@ A Claude Code plugin that transforms your workflow to use persistent markdown fi
|
||||
[](https://code.claude.com/docs/en/plugins)
|
||||
[](https://code.claude.com/docs/en/skills)
|
||||
[](https://docs.cursor.com/context/rules-for-ai)
|
||||
[](https://github.com/OthmanAdi/planning-with-files/releases)
|
||||
[](https://github.com/OthmanAdi/planning-with-files/releases)
|
||||
|
||||
## Quick Install
|
||||
|
||||
@@ -27,6 +27,16 @@ A Claude Code plugin that transforms your workflow to use persistent markdown fi
|
||||
|
||||
See [docs/installation.md](docs/installation.md) for all installation methods.
|
||||
|
||||
## Supported IDEs
|
||||
|
||||
| IDE | Status | Installation Guide | Format |
|
||||
|-----|--------|-------------------|--------|
|
||||
| Claude Code | ✅ Full Support | [Installation](docs/installation.md) | Plugin + SKILL.md |
|
||||
| Cursor | ✅ Full Support | [Cursor Setup](docs/cursor.md) | Rules |
|
||||
| Kilocode | ✅ Full Support | [Kilocode Setup](docs/kilocode.md) | Rules |
|
||||
| OpenCode | ✅ Full Support | [OpenCode Setup](docs/opencode.md) | Personal/Project Skill |
|
||||
| Codex | ✅ Full Support | [Codex Setup](docs/codex.md) | Personal Skill |
|
||||
|
||||
## Documentation
|
||||
|
||||
| Document | Description |
|
||||
@@ -38,12 +48,15 @@ See [docs/installation.md](docs/installation.md) for all installation methods.
|
||||
| [Cursor Setup](docs/cursor.md) | Cursor IDE-specific instructions |
|
||||
| [Windows Setup](docs/windows.md) | Windows-specific notes |
|
||||
| [Kilo Code Support](docs/kilocode.md) | Kilo Code integration guide |
|
||||
| [Codex Setup](docs/codex.md) | Codex IDE installation and usage |
|
||||
| [OpenCode Setup](docs/opencode.md) | OpenCode IDE installation, oh-my-opencode config |
|
||||
|
||||
## Versions
|
||||
|
||||
| Version | Features | Install |
|
||||
|---------|----------|---------|
|
||||
| **v2.2.2** (current) | Restored skill activation language | `/plugin install planning-with-files@planning-with-files` |
|
||||
| **v2.3.0** (current) | Codex & OpenCode IDE support | `/plugin install planning-with-files@planning-with-files` |
|
||||
| **v2.2.2** | Restored skill activation language | See [releases](https://github.com/OthmanAdi/planning-with-files/releases) |
|
||||
| **v2.2.1** | Session recovery after /clear, enhanced PreToolUse hook | See [releases](https://github.com/OthmanAdi/planning-with-files/releases) |
|
||||
| **v2.2.0** | Kilo Code IDE support, Windows PowerShell support, OS-aware hooks | See [releases](https://github.com/OthmanAdi/planning-with-files/releases) |
|
||||
| **v2.1.2** | Fix template cache issue (Issue #18) | See [releases](https://github.com/OthmanAdi/planning-with-files/releases) |
|
||||
@@ -162,7 +175,9 @@ planning-with-files/
|
||||
│ ├── troubleshooting.md
|
||||
│ ├── cursor.md
|
||||
│ ├── windows.md
|
||||
│ └── kilocode.md
|
||||
│ ├── kilocode.md
|
||||
│ ├── codex.md
|
||||
│ └── opencode.md
|
||||
├── planning-with-files/ # Plugin skill folder
|
||||
│ ├── SKILL.md
|
||||
│ ├── templates/
|
||||
@@ -178,6 +193,10 @@ planning-with-files/
|
||||
│ ├── check-complete.sh
|
||||
│ ├── init-session.ps1 # Windows PowerShell
|
||||
│ └── check-complete.ps1 # Windows PowerShell
|
||||
├── .codex/ # Codex IDE installation guide
|
||||
│ └── INSTALL.md
|
||||
├── .opencode/ # OpenCode IDE installation guide
|
||||
│ └── INSTALL.md
|
||||
├── .claude-plugin/ # Plugin manifest
|
||||
├── .cursor/ # Cursor rules
|
||||
├── .kilocode/ # Kilo Code rules
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
# Codex IDE Support
|
||||
|
||||
## Overview
|
||||
|
||||
planning-with-files works with Codex as a personal skill in `~/.codex/skills/`.
|
||||
|
||||
## Installation
|
||||
|
||||
See [.codex/INSTALL.md](../.codex/INSTALL.md) for detailed installation instructions.
|
||||
|
||||
### Quick Install
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.codex/skills
|
||||
cd ~/.codex/skills
|
||||
git clone https://github.com/OthmanAdi/planning-with-files.git
|
||||
```
|
||||
|
||||
## Usage with Superpowers
|
||||
|
||||
If you have [obra/superpowers](https://github.com/obra/superpowers) installed:
|
||||
|
||||
```bash
|
||||
~/.codex/superpowers/.codex/superpowers-codex use-skill planning-with-files
|
||||
```
|
||||
|
||||
## Usage without Superpowers
|
||||
|
||||
Add to your `~/.codex/AGENTS.md`:
|
||||
|
||||
```markdown
|
||||
## Planning with Files
|
||||
|
||||
<IMPORTANT>
|
||||
For complex tasks (3+ steps, research, projects):
|
||||
1. Read skill: `cat ~/.codex/skills/planning-with-files/planning-with-files/SKILL.md`
|
||||
2. Create task_plan.md, findings.md, progress.md in your project directory
|
||||
3. Follow 3-file pattern throughout the task
|
||||
</IMPORTANT>
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
```bash
|
||||
ls -la ~/.codex/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
## Learn More
|
||||
|
||||
- [Installation Guide](installation.md)
|
||||
- [Quick Start](quickstart.md)
|
||||
- [Workflow Diagram](workflow.md)
|
||||
@@ -153,6 +153,14 @@ See [docs/windows.md](windows.md) for Windows-specific installation notes.
|
||||
|
||||
See [docs/cursor.md](cursor.md) for Cursor IDE installation.
|
||||
|
||||
### Codex
|
||||
|
||||
See [docs/codex.md](codex.md) for Codex IDE installation.
|
||||
|
||||
### OpenCode
|
||||
|
||||
See [docs/opencode.md](opencode.md) for OpenCode IDE installation.
|
||||
|
||||
---
|
||||
|
||||
## Need Help?
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
# OpenCode IDE Support
|
||||
|
||||
## Overview
|
||||
|
||||
planning-with-files works with OpenCode as a personal or project skill.
|
||||
|
||||
## Installation
|
||||
|
||||
See [.opencode/INSTALL.md](../.opencode/INSTALL.md) for detailed installation instructions.
|
||||
|
||||
### Quick Install (Global)
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.config/opencode/skills
|
||||
cd ~/.config/opencode/skills
|
||||
git clone https://github.com/OthmanAdi/planning-with-files.git
|
||||
```
|
||||
|
||||
### Quick Install (Project)
|
||||
|
||||
```bash
|
||||
mkdir -p .opencode/skills
|
||||
cd .opencode/skills
|
||||
git clone https://github.com/OthmanAdi/planning-with-files.git
|
||||
```
|
||||
|
||||
## Usage with Superpowers Plugin
|
||||
|
||||
If you have [obra/superpowers](https://github.com/obra/superpowers) OpenCode plugin:
|
||||
|
||||
```
|
||||
Use the use_skill tool with skill_name: "planning-with-files"
|
||||
```
|
||||
|
||||
## Usage without Superpowers
|
||||
|
||||
Manually read the skill file when starting complex tasks:
|
||||
|
||||
```bash
|
||||
cat ~/.config/opencode/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
## oh-my-opencode Compatibility
|
||||
|
||||
If using oh-my-opencode, ensure planning-with-files is not in the `disabled_skills` array:
|
||||
|
||||
**~/.config/opencode/oh-my-opencode.json:**
|
||||
```json
|
||||
{
|
||||
"disabled_skills": []
|
||||
}
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
**Global:**
|
||||
```bash
|
||||
ls -la ~/.config/opencode/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
**Project:**
|
||||
```bash
|
||||
ls -la .opencode/skills/planning-with-files/planning-with-files/SKILL.md
|
||||
```
|
||||
|
||||
## Learn More
|
||||
|
||||
- [Installation Guide](installation.md)
|
||||
- [Quick Start](quickstart.md)
|
||||
- [Workflow Diagram](workflow.md)
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: planning-with-files
|
||||
version: "2.2.2"
|
||||
version: "2.3.0"
|
||||
description: Implements Manus-style file-based planning for complex tasks. Creates task_plan.md, findings.md, and progress.md. Use when starting complex multi-step tasks, research projects, or any task requiring >5 tool calls. Now with automatic session recovery after /clear.
|
||||
user-invocable: true
|
||||
allowed-tools:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: planning-with-files
|
||||
version: "2.2.2"
|
||||
version: "2.3.0"
|
||||
description: Implements Manus-style file-based planning for complex tasks. Creates task_plan.md, findings.md, and progress.md. Use when starting complex multi-step tasks, research projects, or any task requiring >5 tool calls. Now with automatic session recovery after /clear.
|
||||
user-invocable: true
|
||||
allowed-tools:
|
||||
|
||||
Reference in New Issue
Block a user