All commands · evidence

pm item docs

Manage docs linked to an item.

Associates relevant documentation paths with tracker items.

Usage

pm item docs [options] <id>

Arguments

<id>Item idrequired

Options

--add <value>Add linked doc entry (CSV/markdown pairs or - for stdin)optional
--add-glob <value>Add linked doc entries from a glob (plain glob or pattern=<glob>,scope=<scope>,note=<text>; repeatable)optional
--remove <value>Remove linked doc by path only (path=<value>, path:<value>, plain path, or - for stdin); does not accept note=/scope= — record removal context with --messageoptional
--migrate <value>Migrate linked doc paths in-place (from=<prefix>,to=<prefix>; repeatable)optional
--note <value>Note attached to every link added by --add/--add-glob in this invocation (embedded note= wins)optional
--listList linked docs without mutatingoptional
--validate-pathsValidate linked doc paths for existence and file shapeoptional
--author <value>Mutation authoroptional
--message <value>History messageoptional
--forceForce ownership overrideoptional

Examples

pm item docs pm-a1b2 --add "path=README.md,note=user-facing command guidance"

Related commands