Skip to content

Project files ​

PathOwnerCommit to GitWrite path
*.planAuthorYesManual editing, explicit CLI mutation, or planq format
plan.manifest.jsonAuthorYesManual editing
resources.planAuthorYesManual editing or planq resources format
resources.lock.jsonPlanQ CLIYesplanq resources sync --accept only
.plan/Local CLINoConnection and preview state
.agents/skills/plan-gantt/ProjectUsuallyplanq skill install, then normal review
.claude/skills/plan-gantt/SKILL.mdProjectUsuallyplanq skill install; lightweight forwarder
.trae/skills/plan-gantt/SKILL.mdProjectUsuallyplanq skill install; lightweight forwarder

*.plan ​

Plan files are the source of author intent. Each file contains one complete Plan. Includes load other explicit Plan files; PlanQ never scans a directory for implicit entries.

plan.manifest.json ​

The project manifest is strict JSON:

json
{
  "manifestVersion": "1",
  "entries": ["release.plan", "operations.plan"]
}

It declares a non-empty, ordered entry set relative to the project root. Unknown fields, duplicate paths, escapes, symlinks, and non-.plan targets are rejected.

resources.plan ​

This optional DSL document is the local, human-maintained source for people, the default work week, holidays, leave, and overtime. All project entries share it. Run planq resources format to materialize derived person IDs and apply canonical formatting.

resources.lock.json ​

This optional strict JSON file is a complete, reviewed snapshot of online resources. Generate it only with:

bash
planq resources sync
planq resources sync --accept

The first command shows a diff. --accept atomically writes the reviewed snapshot. Do not edit it manually.

.plan/ ​

This local directory may contain Workspace connection and preview session state. Add .plan/ to .gitignore. Its contents can include private connection identity and must not enter a repository or release archive.

.agents/skills/plan-gantt/ ​

The Skill is installed explicitly inside the Git root. The CLI refuses to overwrite conflicts. Treat it as a reviewed project dependency; package manager removal does not delete it.

Agent discovery forwarders ​

Claude Code and TRAE use their own project discovery directories. PlanQ writes one deterministic SKILL.md forwarder at each path; the full rules, references, and fixtures remain only under .agents/skills/plan-gantt/. An existing repository-local relative symlink that resolves exactly to the canonical directory is also accepted.

Codex discovers the canonical directory directly. PlanQ does not create .codex/skills and does not install any Skill under the user home directory.

PlanQ documentation