Skip to content

A CommandBox command for accessing cfdocs.org documentation from the command line.

License

Notifications You must be signed in to change notification settings

foundeo/cfdocs-command

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A CommandBox command for accessing cfdocs.org documentation.

Screen Shot

Install

First make sure you have CommandBox installed, then type:

box install cfdocs

Or if you are already within the CommandBox CLI, you can just type:

install cfdocs

Using the command

There are a few display modes you can use, the default:

doc cfdump

If you want full or verbose documentation try:

doc cfdump full

If you want a listing of function arguments try:

doc rereplace arguments

For tag attributes use:

doc cfhttp attributes

For examples try:

doc rereplace examples

There are a few shortcuts to these modes, you can use args instead of arguments, or attr instead of attributes, or ex instead of examples.