Function refactorIndexCommand

refactorIndexCommand(
filePath: string,
options: RefactorIndexCliOptions,
): Promise<void>
Execute the refactor-index command, converting a README.md to index.md or an index.md to README.md in place with automatic link updates.

This is the entry point for the CLI command. It reports the outcome in conventional or JSON form, exits non-zero when the conversion is refused or fails, and surfaces parse failures the move machinery encountered along the way.
Parameters
- filePath: string
  Path to the README.md or index.md file to convert
- options: RefactorIndexCliOptions
  CLI configuration options for the operation
Returns Promise<void>

Example
typescript await refactorIndexCommand('docs/README.md', { to: 'index' }); ;

Throws
Will exit the process with code 1 if the operation is refused or fails
- Defined in commands/refactor-index.ts:227