Using CSDoc from CLI

Usage: csdoc [script]

Options:
  -d, --dep       Add dependency (mdn, node)
  -i, --inner     Use inner comments.         [default: false]
  -t, --template  Use template (json, html)   [default: "json"]
  -h, --help      Show this help            

See Options, Using CSDoc with .csdoc.json file

Examples

To create json documentation from a single file:

$ csdoc ./script.coffee

To create json documentation from all .coffee files in ./src folder:

$ csdoc ./src

To create html documentation from all .coffee files in ./src folder with builtin JS objects:

$ csdoc --template html --dep mdn ./src

By default, documentation is created in ./docs folder of your current working directory.

Pipes

$ csdoc <script.coffee
$ csdoc <script.coffee >docs.json