Skip to main content

Docs

Document a repository of files or a single file.

Synopsis

Document an entire repository of files. Specify the path to the repo as the first positional argument. This command will recursively search for files in the directory and document them. If a single file is specified, it will be documented.

otto docs [flags]

Options

  -h, --help               help for docs
-n, --ignore string path to .gptignore file
-g, --ignore-gitignore ignore .gitignore file
-i, --inline Output in inline format
-m, --markdown Output in Markdown format
-o, --output string Path to the output file. For use with --markdown
-w, --overwrite Overwrite the original file
-p, --prompt string Prompt to use for the ChatGPT API

SEE ALSO

  • otto - Document your code with ease
Auto generated by spf13/cobra on 23-Apr-2023