menu.yaml

---
- cmd: ["help", "--help", "-h"]
  text: "Show help message about supported commands."
- cmd: ["init", "init DIRECTORY_PATH"]
  text: "Create configuration files in current directory or in DIRECTORY_PATH."
- cmd: sources
  children:
    - cmd: "add DIRECTORY REPO BRANCH"
      text: "Add git submodule into DIRECTORY from REPO and track BRANCH by default."
    - cmd: "delete DIRECTORY"
      text: "Delete git submodule from DIRECTORY."
    - cmd: ["update", "update DIRECTORY ..."]
      text: >
        Update git submodule from upstream in DIRECTORY or in all git submodules if DIRECTORY
        is not specified. You may pass one or more directory paths (DIRECTORY ...) to update
        their contents.
- cmd: ["version", "--version", "-v"]
  text: "Show program version"
- cmd: works
  children:
    - cmd: ["covered", "covered DIRECTORY ..."]
      text: >
        List files of sources which have been used for published works. Pass one or more directory
        paths (DIRECTORY ...) to show files only in these directories.
    - cmd: ["ignored", "ignored DIRECTORY ..."]
      text: >
        List ignored files. Pass one or more directory paths (DIRECTORY ...) to show files only in
        these directories.
    - cmd: ["outdated", "outdated DIRECTORY ..."]
      text: >
        List documents which may contain outdated information. Pass one or more directory paths
        (DIRECTORY ...) to show files only in these directories.
    - cmd: ["publish DOCUMENT", "publish DOCUMENT FILE_PATH ..."]
      text:
        - >
          Save record about work (DOCUMENT) and pass list of file paths of sources
          (FILE_PATH ...) which relate to this work. You should prepend minus sign to file path
          to exclude it from list of related sources. Examples:
        - >
          works publish _/docker/compose.md docs.docker.com/content/manuals/compose/**/*.md
        - >
          works publish _/docker/compose.md -docs.docker.com/**/*.md
    - cmd: ["uncovered", "uncovered DIRECTORY ..."]
      text: >
        List files of sources which have NOT been used for published works. Pass one or more
        directory paths (DIRECTORY ...) to show files only in these directories.
    - cmd: ["unknown", "unknown DIRECTORY ..."]
      text: >
        List files of sources which may be used for works or ignored. Pass one or more directory
        paths (DIRECTORY ...) to show files only in these directories.