Artifact Ignore

artifact-ignore.md defines files in a task artifact scope that are useful while working but should not be synced as user-visible artifacts.

File Location

Global rules are declared at the root of the current XWorkmate/OpenClaw artifact scope:

tasks/<session>/<run>/artifact-ignore.md

Skill-specific rules are declared under the selected skill key:

tasks/<session>/<run>/skills/<skill-key>/artifact-ignore.md

Examples:

tasks/<session>/<run>/skills/video-production/it-infra-evolution-video-v2/artifact-ignore.md
tasks/<session>/<run>/skills/workflows/content-pdf-with-images/artifact-ignore.md

The app loads the global file first, then the artifact-ignore.md files for the skills selected on the current task. Rules are evaluated relative to the current artifact scope. They do not apply to files outside the current run directory.

Contract

The file controls artifact sync/export only. It must not delete files or hide required final deliverables from validation.
Final deliverables must stay syncable. Do not ignore files the user asked for, files listed in DELIVERY.md, or required manifests such as assets/images/manifest.md.
A failed or missing required deliverable is still a failure even when an ignore rule would match another intermediate file.
The ignore file itself should not be shown as a final artifact.

Rule Format

Use one rule per line in a fenced artifact-ignore block:

# comments are allowed
tmp/
cache/
*.log
*.tmp
**/.DS_Store

Rule syntax:

Rule	Meaning
`path/to/file.ext`	Ignore one file relative to the artifact scope
`dir/`	Ignore a directory and its contents
`*.ext`	Ignore matching files in the artifact scope root
`*/.ext`	Ignore matching files at any depth
`# comment`	Comment
blank line	Ignored

Keep the rule set small and explicit. Prefer listing known intermediate directories over broad patterns such as **/*.

Content Reject Rules

Use a fenced artifact-reject block when a generated artifact is known to be a placeholder or guard file that must not appear as a user-visible final deliverable. The app loads these rules from the current artifact scope and applies them during artifact sync/export.

path=exports/final.pdf
contentType=application/pdf
contains=XWorkmate Task Artifact
contains=Required extensions: pdf
contains=TaskThread workspace context:
contains=Workspace isolation rules:

Supported fields:

Field	Meaning
`path`	Optional relative path or extension glob, for example `exports/final.pdf`, `.pdf`, or `/.pdf`
`contentType`	Optional substring match against the artifact content type
`contains`	Required. Repeat for every text fragment that must be present in the artifact body

Rules match only when every supplied field matches. Keep reject rules narrow: they are for explicit placeholder/guard signatures, not for broad file-type blocking. A real requested deliverable must not be rejected by policy.

Recommended Intermediate Rules

These paths are normally safe to ignore when they exist only as build or scratch outputs:

tmp/
cache/
.cache/
work/
scratch/
logs/
*.log
*.tmp
*.part
*.download
**/.DS_Store

Video workflows can additionally ignore transient render inputs when final MP4 and validation files remain syncable:

frames/
snapshots/
assets/audio/raw/
assets/audio/tmp/
renders/tmp/
*.wav.tmp

Image workflows can ignore generation scratch state when the final PNG/JPG files and manifest remain syncable:

prompts/tmp/
assets/images/tmp/
assets/images/raw/
*.seed.json

PDF/document workflows can ignore converter scratch files when the final document remains syncable:

build/
latex.out/
*.aux
*.toc
*.synctex.gz

Minimal Example

# Artifact Ignore

```artifact-ignore
tmp/
cache/
*.log
renders/tmp/
frames/
```

With this example, renders/final.mp4, ffprobe.json, DELIVERY.md, and assets/images/manifest.md remain eligible for sync, while scratch files under tmp/, cache/, renders/tmp/, and frames/ are skipped.

4.2 KiB Raw Permalink Blame History