sync-it/src/cli.yml

name: sync-it
author: Samuel W. Flint <swflint@flintfam.org>
about: Synchronize directories flexibly
settings:
  - SubcommandRequired
args:
    - config:
        short: c
        long: config
        value_name: FILE
        help: Sets a custom config file
        takes_value: true
    - license:
        short: l
        long: license
        help: Shows license
        takes_value: false
subcommands:
  - run:
      about: Run sychronization for repositories and groups
      aliases:
        - sync
        - rr
      args:
        - name:
            index: 1
            multiple: true
            value_name: REPO_OR_GROUP
            help: The name of a repository or group to sync
  - repository:
      about: Create and manage repositories
      settings:
        - SubcommandRequired
      aliases:
        - repo
        - r
      subcommands:
        - list:
            about: List repositories
        - register:
            about: Register the current directory as a repository
            args:
              - type:
                  index: 1
                  value_name: REPO_TYPE
                  help: The type of repository
                  required: true
              - name:
                  long: name
                  short: n
                  value_name: REPO_NAME
                  help: The name of the repository
              - options:
                  index: 2
                  value_name: OPTION
                  help: Type-specific options, in form "name=value"
                  multiple: true
        - config:
            about: Configure a repository
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the repository
                  required: true
              - autocreate:
                  long: autocreate
                  value_name: YES/NO
                  help: Enable autocreation
                  takes_value: true
                  multiple: false
              - disable:
                  long: disable
                  value_name: YES/NO
                  help: Disable repository
                  takes_value: true
                  multiple: false
              - options:
                  long: options
                  value_name: OPTION=VALUE
                  help: Type-specific options
                  multiple: true
                  takes_value: true
        - remove:
            about: Remove a repository from the configuration
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the repository
                  required: true
        - show:
            about: Show information about a repository
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the repository
                  required: true
  - group:
      about: Create and manage groups of repositories
      settings:
        - SubcommandRequired
      subcommands:
        - create:
            about: Create a group
            args:
              - name:
                  index: 1
                  value_name: GROUP_NAME
                  help: The name of the group
                  required: true
        - delete:
            about: Delete a group
            args:
              - name:
                  index: 1
                  value_name: GROUP_NAME
                  help: The name of the group
                  required: true
        - add:
            about: Add a repo to a group
            args:
              - name:
                  index: 1
                  value_name: GROUP_NAME
                  help: The name of the group
                  required: true
              - repo:
                  index: 2
                  value_name: REPO_NAME
                  help: The name of the repo
                  required: true
        - act:
            about: Add action to a group
            args:
              - name:
                   index: 1
                   value_name: GROUP_NAME
                   help: The name of the group
                   required: true
              - action:
                    index: 2
                    value_name: ACTION_NAME
                    help: The name of the action
                    required: true
        - remove:
            about: Remove a repo from a group
            args:
              - name:
                  index: 1
                  value_name: GROUP_NAME
                  help: The name of the group
                  required: true
              - repo:
                  index: 2
                  value_name: REPO_NAME
                  help: The name of the repo
                  required: true
        - drop:
            about: Remove a group
            args:
              - name:
                  index: 1
                  value_name: GROUP_NAME
                  help: The name of the group
                  required: true
        - show:
            about: Show information about a group
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the group
                  required: true
        - list:
            about: List known groups
  - type:
      about: Create and manage repository types
      settings:
        - SubcommandRequired
      subcommands:
        - create:
            about: Create a new repository type
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: Name of the repository type
                  required: true
              - description:
                  long: description
                  takes_value: true
                  help: Description of the repository type
              - create:
                  long: create
                  takes_value: true
                  help: Command to create a repository of type NAME
              - inward:
                  long: inward
                  takes_value: true
                  help: Command to perform inward sync of a repository of type NAME
              - outward:
                  long: outward
                  takes_value: true
                  help: Command to perform outward sync of a repository of type NAME
              - status:
                  long: status
                  takes_value: true
                  help: Command to display status of repository
              - pre_inward:
                  long: pre-inward
                  takes_value: true
                  help: Command describing potential pre-inward action
              - post_inward:
                  long: post-inward
                  takes_value: true
                  help: Command describing post-inward action
              - post_outward:
                  long: post-outward
                  takes_value: true
                  help: Command describing post-outward action
        - config:
            about: Configure a repository type
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: Name of the repository type
                  required: true
              - description:
                  long: description
                  takes_value: true
                  help: Description of the repository type
              - create:
                  long: create
                  takes_value: true
                  help: Command to create a repository of type NAME
              - inward:
                  long: inward
                  takes_value: true
                  help: Command to perform inward sync of a repository of type NAME
              - outward:
                  long: outward
                  takes_value: true
                  help: Command to perform outward sync of a repository of type NAME
              - status:
                  long: status
                  takes_value: true
                  help: Command to display status of repository
              - pre_inward:
                  long: pre-inward
                  takes_value: true
                  help: Command describing potential pre-inward action
              - post_inward:
                  long: post-inward
                  takes_value: true
                  help: Command describing post-inward action
              - post_outward:
                  long: post-outward
                  takes_value: true
                  help: Command describing post-outward action
        - show:
            about: Show information about a type
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the repository type
                  required: true
        - list:
            about: List known repository types
  - action:
      about: Create and manage actions
      settings:
        - SubcommandRequired
      subcommands:
        - create:
            about: Create a new action
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the action
                  required: true
              - command:
                  index: 2
                  value_name: COMMAND
                  help: The command the action runs
                  required: true
              - description:
                  long: description
                  value_name: DESCRIPTION
                  help: Description of the action
                  takes_value: true
        - config:
            about: Configure an action
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the action
                  required: true
              - disabled:
                  long: disabled
                  value_name: YES/NO
                  help: Enable this action
                  takes_value: true
              - command:
                  long: command
                  value_name: COMMAND
                  help: The command the action runs
                  takes_value: true
                  required: true
              - description:
                  long: description
                  value_name: DESCRIPTION
                  help: Description of the action
                  takes_value: true
        - show:
            about: Show information about an action
            args:
              - name:
                  index: 1
                  value_name: NAME
                  help: The name of the repository type
                  required: true
        - list:
            about: List known actions