Home

Welcome to the docpie wiki!

Summary

docpie is a python command-line interface utility which can build CLI by analyze your doc-string.

docpie shares most syntax as docopt, with more features.

If you've already tried docopt, go Why docpie and read the Note section.

Document Structure

Basic Usage

• Quick Start
• Install
• Usage Format
• Options Format
• Basic APIs
  • help message
  • -h/--help automatic handling
  • -v/--version automatic handling
  • specify program's name

Advanced Usage

• Advanced APIs
  • handling --
  • wrap another program
  • remove not-appeared options
  • [options] placeholder
• Docpie
  • attributes
  • change config
  • change section title
  • serialization and JSONlization
  • preview
• Auto Handler

More

• Experimental APIs
• Why docpie?

基本用法

• 快速开始
• 安装