Skip to content

CLI Commands

Terminal window
Usage: repotype [options] [command]
Repository schema validation, scaffolding, fix, and service runtime
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
validate [options] [target]
report [options] [target]
fix [options] [target]
cleanup-run [options] [target]
install-checks [options]
install-watcher [options]

Validate repository against rules

Terminal window
repotype validate repotype validate [options] [target]

Options:

FlagDescription
--jsonemit machine-readable JSON (default: false)
--config <path>explicit config file path (repotype.yaml) (default: "")
-h,—help display help for command
Full help output
Usage: repotype validate [options] [target]
Arguments:
target file or directory to validate (default: ".")
Options:
--json emit machine-readable JSON (default: false)
--config <path> explicit config file path (repotype.yaml) (default: "")
-h, --help display help for command

Auto-fix violations

Terminal window
repotype fix repotype fix [options] [target]

Options:

FlagDescription
--config <path>explicit config file path (repotype.yaml) (default: "")
-h,—help display help for command
Full help output
Usage: repotype fix [options] [target]
Arguments:
target file or directory to validate/fix (default: ".")
Options:
--config <path> explicit config file path (repotype.yaml) (default: "")
-h, --help display help for command

Generate compliance reports

Terminal window
repotype report repotype report [options] [target]

Options:

FlagDescription
--jsonemit machine-readable JSON report (default: false)
--format <format>report format: markdown
--config <path>explicit config file path (repotype.yaml) (default: "")
--output <file>write report to file
-h,—help display help for command
Full help output
Usage: repotype report [options] [target]
Arguments:
target file or directory to report on (default: ".")
Options:
--json emit machine-readable JSON report (default: false)
--format <format> report format: markdown | json | html (default:
"markdown")
--config <path> explicit config file path (repotype.yaml) (default: "")
--output <file> write report to file
-h, --help display help for command

Explain rules for a specific file

Terminal window
repotype explain repotype explain [options] <file>

Options:

FlagDescription
--jsonemit machine-readable JSON (default: false)
--config <path>explicit config file path (repotype.yaml) (default: "")
-h,—help display help for command
Full help output
Usage: repotype explain [options] <file>
Arguments:
file file path
Options:
--json emit machine-readable JSON (default: false)
--config <path> explicit config file path (repotype.yaml) (default: "")
-h, --help display help for command

Initialize repotype.yaml config

Terminal window
repotype init repotype init [options] [target]

Options:

FlagDescription
--type <type>preset type: default
--from <path>external YAML config to copy as repotype.yaml
--forceoverwrite existing repotype.yaml if present (default: false)
-h,—help display help for command
Full help output
Usage: repotype init [options] [target]
Initialize repotype.yaml from generic preset or external source
Arguments:
target target directory for repotype.yaml (default: ".")
Options:
--type <type> preset type: default|strict (default: "default")
--from <path> external YAML config to copy as repotype.yaml
--force overwrite existing repotype.yaml if present (default: false)
-h, --help display help for command

Show operations status

Terminal window
repotype status repotype status [options] [target]

Options:

FlagDescription
--jsonemit machine-readable JSON (default: false)
-h,—help display help for command
Full help output
Usage: repotype status [options] [target]
Arguments:
target repository path (default: ".")
Options:
--json emit machine-readable JSON (default: false)
-h, --help display help for command

Apply operations (hooks, watcher)

Terminal window
repotype apply repotype apply [options] [target]

Options:

FlagDescription
--jsonemit machine-readable JSON (default: false)
-h,—help display help for command
Full help output
Usage: repotype apply [options] [target]
Arguments:
target repository path (default: ".")
Options:
--json emit machine-readable JSON (default: false)
-h, --help display help for command

Generate files from templates

Terminal window
repotype scaffold repotype scaffold [options] <templateId> <output>

Options:

FlagDescription
--set <kv>template variable key=value (default: [])
-h,—help display help for command
Full help output
Usage: repotype scaffold [options] <templateId> <output>
Arguments:
templateId template id from repotype.yaml
output output file path
Options:
--set <kv> template variable key=value (default: [])
-h, --help display help for command

Move severely invalid files to queue

Terminal window
repotype cleanup-run repotype cleanup-run [options] [target]

Options:

FlagDescription
--queue <dir>sort queue directory (default: “sort_queue”)
--min-errors <n>minimum error count before moving file (default: “3”)
--dry-runshow what would be moved without moving files (default:
--jsonemit machine-readable JSON (default: false)
-h,—help display help for command
Full help output
Usage: repotype cleanup-run [options] [target]
Arguments:
target file or directory to validate/cleanup (default: ".")
Options:
--queue <dir> sort queue directory (default: "sort_queue")
--min-errors <n> minimum error count before moving file (default: "3")
--dry-run show what would be moved without moving files (default:
false)
--json emit machine-readable JSON (default: false)
-h, --help display help for command

Install git hooks

Terminal window
repotype install-checks repotype install-checks [options]

Options:

FlagDescription
--hook <hook>pre-commit
--target <dir>repository path (default: ”.”)
-h,—help display help for command
Full help output
Usage: repotype install-checks [options]
Options:
--hook <hook> pre-commit | pre-push | both (default: "both")
--target <dir> repository path (default: ".")
-h, --help display help for command

Install file watcher

Terminal window
repotype install-watcher repotype install-watcher [options]

Options:

FlagDescription
--target <dir>repository path (default: ”.”)
--schedule <cron>cron schedule expression (default: ”*/15 * * * *“)
--queue <dir>sort queue directory (default: “sort_queue”)
--min-errors <n>minimum errors before moving file (default: “3”)
--log-file <file>watcher stdout/stderr log file (default:
--dry-runprint cron line without writing crontab (default: false)
-h,—help display help for command
Full help output
Usage: repotype install-watcher [options]
Options:
--target <dir> repository path (default: ".")
--schedule <cron> cron schedule expression (default: "*/15 * * * *")
--queue <dir> sort queue directory (default: "sort_queue")
--min-errors <n> minimum errors before moving file (default: "3")
--log-file <file> watcher stdout/stderr log file (default:
".repotype/logs/watcher.log")
--dry-run print cron line without writing crontab (default: false)
-h, --help display help for command

Generate schema from existing files

Terminal window
repotype generate schema repotype generate schema [options] <target> <output>

Options:

FlagDescription
--pattern <glob>glob pattern when target is a directory (default:
-h,—help display help for command
Full help output
Usage: repotype generate schema [options] <target> <output>
Arguments:
target file or directory to infer frontmatter schema from
output output JSON schema path
Options:
--pattern <glob> glob pattern when target is a directory (default:
"**/*.md")
-h, --help display help for command

Show plugin status

Terminal window
repotype plugins status repotype plugins status [options] [target]

Options:

FlagDescription
--jsonemit machine-readable JSON (default: false)
-h,—help display help for command
Full help output
Usage: repotype plugins status [options] [target]
Arguments:
target repository path (default: ".")
Options:
--json emit machine-readable JSON (default: false)
-h, --help display help for command

Install plugin dependencies

Terminal window
repotype plugins install repotype plugins install [options] [target]

Options:

FlagDescription
--jsonemit machine-readable JSON (default: false)
-h,—help display help for command
Full help output
Usage: repotype plugins install [options] [target]
Arguments:
target repository path (default: ".")
Options:
--json emit machine-readable JSON (default: false)
-h, --help display help for command

Start HTTP API server

Terminal window
repotype serve repotype serve [options]

Options:

FlagDescription
--port <port>service port (default: “4310”)
--cwd <cwd>service working directory (default:
-h,—help display help for command
Full help output
Usage: repotype serve [options]
Options:
--port <port> service port (default: "4310")
--cwd <cwd> service working directory (default:
"/Users/saiterminal/git/supernal/families/supernal-coding/packages/repotype")
-h, --help display help for command

These options work with all commands:

FlagDescription
--helpShow help for command
--versionShow version number
--jsonOutput in JSON format
CodeMeaning
0Success
1Validation errors found
2Configuration or runtime error