Skip to content

Guide · Agent skill

How to use the Planning with Files agent skill

Updated · written with AI from the project's own documentation and checked against our catalogue data

Planning with Files is an agent skill that tells an AI coding agent to keep its working plan in markdown files inside your project, rather than relying only on its short-term memory. It is aimed at developers running long, multi-step agent tasks of roughly five or more tool calls who lose track of progress after a context reset. After this guide you will know what the skill does, how to install it from the ZIP on this page, how to trigger it, and what it needs and touches on your machine.

Planning with FilesOthmanAdi/planning-with-files · MIT

Quick start

  1. 1Download and unzip. Download the ZIP from this page and unzip it into ~/.claude/skills/ or a project's .claude/skills/ folder.
  2. 2Or upload in the Claude apps. Go to Settings → Capabilities → Skills and upload the skill instead.
  3. 3Check requirements. Confirm you have a bash or sh shell, Python 3, and Git, or PowerShell on Windows.
  4. 4Describe a multi-step task. Ask the agent for a task needing five or more tool calls and mention planning in files.
  5. 5Review the plan. Open task_plan.md in your project root and check the goal, phases and key questions.
  6. 6Validate the plan. Run check-complete.sh --validate on the plan file to confirm the phase markers are correct.
  7. 7Resume after a reset. Ask the agent to restore the project state from the planning files before continuing.

What the skill makes the agent do

Planning with Files asks the agent to use three persistent files as its working memory: task_plan.md, findings.md, and progress.md. These are written to disk in your project, so the plan survives when the conversation gets long or resets.

The skill also includes lifecycle hooks that can inject the selected project planning context at prompt time, and helper scripts that can check phase completion, lock a plan with a hash, and read recent local session records to help recover after a context reset.

  • task_plan.md holds the goal and phases.
  • findings.md holds research notes and decisions.
  • progress.md holds a log of what was done.
  • Automatic recovery reads project planning files only.

Install the skill from the ZIP

Download the ZIP for this skill from this page and unzip it. You can place the skill folder in one of two locations: your user-level skills directory at ~/.claude/skills/, or a project-specific .claude/skills/ folder inside the project you are working on.

Alternatively, if you use the Claude apps, you can upload the skill under Settings → Capabilities → Skills instead of copying files by hand.

  • User-level: unzip into ~/.claude/skills/
  • Per project: unzip into .claude/skills/ inside your project
  • Claude apps: Settings → Capabilities → Skills, then upload

Trigger the skill with natural requests

The skill is user-invocable, and its description says it is meant for research or work needing 5+ tool calls. You do not need special syntax: describe a multi-step task and ask the agent to plan it in files. Before a complex task, the skill directs the agent to restore any existing plan first, then create one only for a new task.

Planning files go in your project directory, not the skill installation folder. Templates and scripts stay in the skill directory.

  • "Research X and write a summary, keep the plan in task_plan.md."
  • "Resume the migration task from our plan files."
  • "Plan this multi-file refactor using planning files before you edit anything."

Example: a research task

The bundled examples show a research request such as researching the benefits of morning exercise and writing a summary. The agent first writes task_plan.md with a goal, a list of phases, and key questions, then re-reads it before each step, records sources in findings.md, and marks phases complete as it goes.

When a new plan is created, the skill's initializer script is run from the project root, and the plan is validated afterwards. Each phase must keep a single status line set to pending, in_progress, or complete.

sh "$PWF_SKILL_DIR/scripts/init-session.sh" sh "$PWF_SKILL_DIR/scripts/check-complete.sh" --validate path/to/task_plan.md

What the skill needs and touches

The skill needs a bash or sh shell, Python 3 for session-catchup.py, and Git for git diff --stat progress checks. On Windows it uses PowerShell or .ps1 equivalents. It runs scripts and does not use the network.

Session recovery is explicit. The --metadata option reads same-project local agent session records and emits aggregate counts only. The --replay option is a deliberate, bounded action that can emit excerpts from those records, which you should treat as untrusted data. The skill has no network upload path.

  • Requires: bash or sh, Python 3, Git, PowerShell for Windows
  • Runs scripts: yes
  • Uses network: no
  • Hooks and scripts execute locally, so review them before enabling in sensitive repos
python "$env:USERPROFILE\.codebuddy\skills\planning-with-files\scripts\session-catchup.py" --metadata (Get-Location)

Tips for getting good results

Keep the plan file readable and editable. It is an auditable record you can correct at any time. Re-read the plan before major decisions, and update progress after each phase.

For parallel work, assign one owner to the shared plan. Workers should report through their own ledgers or assigned files rather than rewriting the shared planning files. Existing planning files should not be overwritten.

  • Give each parallel host its own pinned plan or a separate worktree.
  • Do not enable --replay in repositories with sensitive session data.
  • Keep the native phase and status markers when tailoring a generated plan.

What people use it for

  • Multi-step research that needs sources recorded in findings.md
  • Long refactors where progress.md tracks which files are done
  • Parallel agent work where one orchestrator owns a shared plan
  • Analytics investigations that log data sources, hypotheses and query results

Frequently asked questions

How do I install the planning-with-files skill?

Download the ZIP from this page and unzip it into ~/.claude/skills/ for all projects, or into a project's .claude/skills/ folder for one project. In the Claude apps you can instead upload it under Settings → Capabilities → Skills.

Is planning-with-files free to use?

The skill is published under the MIT licence, as stated on this page. Check the licence file in the source repository for the full terms.

What do I need to run planning-with-files?

You need a bash or sh shell, Python 3 for session-catchup.py, and Git for progress checks. On Windows, PowerShell or the .ps1 equivalents are used.

Does planning-with-files send my data over the network?

The skill has no network upload path and does not use the network. Its scripts and hooks run locally, so review them before enabling in sensitive repositories.

Why is the agent not picking up my plan?

If the hook script cannot be found, plan injection is off and a message says so on prompts. Set PWF_SCRIPT_DIR to the skill's scripts directory, or install the skill to a user-level path.

Should I use --replay or --metadata?

Use --metadata by default, since it emits only aggregate counts. Use --replay only for a deliberate bounded replay, because it can surface excerpts from local session records into the agent's context.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Planning with Files suits developers running long, multi-step agent tasks who lose track after context resets, and teams who want an auditable, editable plan file. Skip it for quick questions or small edits, where the planning overhead adds nothing, and avoid it in sensitive repositories if you enable replay or do not want agents running local scripts.

Download the skill